Skip to content

fix and improve documentation for preserve_host #55

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

Open
jjb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix and improve documentation for preserve_host #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,20 @@ Right now if more than one rule matches any given route, it throws an exception

### Options

#### Terminology

<dl>
<dt>Source Request</dt>
<dd>The request sent from the end user's browser to the rack stack which is running rack-reverse-proxy.</dd>
<dt>Target Request</dt>
<dd>The request sent from rack-reverse-proxy to the server which will produce the response.</dd>
</dl>

`reverse_proxy_options` sets global options for all reverse proxies. Available options are:

* `:preserve_host` Set to false to omit Host headers
* `:preserve_host` This determines which Host header is used in the target request. If set to `true`, the target
request's host (specified in the `reverse_proxy` invocation) will be used. If set to `false`, the source request's
Host header will be re-used for the target request. Default: `true`.
* `:username` username for basic auth
* `:password` password for basic auth
* `:matching` is a global only option, if set to :first the first matched url will be requested (no ambigous error). Default: :all.
Expand Down