Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md - clarify use of localhost gem [ci skip] #3189

Merged
merged 2 commits into from Jun 30, 2023

Conversation

MSP-Greg
Copy link
Member

@MSP-Greg MSP-Greg commented Jun 30, 2023

Description

The current README.md describes how to use the localhost gem in development, but implies that one can require it in a rackup file. That is incorrect, as it needs to be required in a configuration file.

Updated README.md to clarify.

Closes #2818
Closes #3068

Your checklist for this pull request

  • I have reviewed the guidelines for contributing to this repository.
  • I have added (or updated) appropriate tests if this PR fixes a bug or adds a feature.
  • My pull request is 100 lines added/removed or less so that it can be easily reviewed.
  • If this PR doesn't need tests (docs change), I added [ci skip] to the title of the PR.
  • If this closes any issues, I have added "Closes #issue" to the PR description or my commit messages.
  • I have updated the documentation accordingly.
  • All new and existing tests passed, including Rubocop.

@MSP-Greg
Copy link
Member Author

@dentarg

Thanks. I updated the 'sample' configuration file, now it's simply the following:

require 'localhost'
# configuration methods (from Puma::DSL) as needed

Do you think that's descriptive enough?

@dentarg
Copy link
Member

dentarg commented Jun 30, 2023

Yes

@MSP-Greg MSP-Greg added the docs label Jun 30, 2023
@MSP-Greg MSP-Greg merged commit 55e4c0b into puma:master Jun 30, 2023
10 checks passed
@MSP-Greg MSP-Greg deleted the 00-localhost-readme branch June 30, 2023 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Self-signed SSL certificates (via the localhost) with Cluster mode is raised an error
2 participants