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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
Jun 30, 2023
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26c234f
README.md - clarify use of localhost gem [ci skip]
MSP-Greg Jun 30, 2023
8429920
README.md - correct sample configuration file
MSP-Greg Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,29 +211,32 @@ Puma supports the [`localhost`] gem for self-signed certificates. This is partic

Puma automatically configures SSL when the [`localhost`] gem is loaded in a `development` environment:

Add the gem to your Gemfile:
```ruby
# Add the gem to your Gemfile
group(:development) do
gem 'localhost'
end
```

# And require it implicitly using bundler
And require it implicitly using bundler:
```ruby
require "bundler"
Bundler.require(:default, ENV["RACK_ENV"].to_sym)
```

# Alternatively, you can require the gem in config.ru:
require './app'
Alternatively, you can require the gem in your configuration file, either `config/puma/development.rb`, `config/puma.rb`, or set via the `-C` cli option:
```ruby
require 'localhost'
run Sinatra::Application
# configuration methods (from Puma::DSL) as needed
```

Additionally, Puma must be listening to an SSL socket:

```shell
$ puma -b 'ssl://localhost:9292' config.ru
$ puma -b 'ssl://localhost:9292' -C config/use_local_host.rb

# The following options allow you to reach Puma over HTTP as well:
$ puma -b ssl://localhost:9292 -b tcp://localhost:9393 config.ru
$ puma -b ssl://localhost:9292 -b tcp://localhost:9393 -C config/use_local_host.rb
```

[`localhost`]: https://github.com/socketry/localhost
Expand Down