docs: Clarify nginx reverse proxy documentation.

Fixes #14740.
This commit is contained in:
Tim Abbott 2020-04-26 10:51:39 -07:00
parent f7fbe3419f
commit 9566905b81
1 changed files with 13 additions and 5 deletions

View File

@ -209,10 +209,17 @@ instead of HTTPS.
### nginx configuration
You can look at our
[nginx reverse proxy configuration][nginx-loadbalancer] to see an
example of how to do this properly (the various include files are
available via the `zulip::nginx` puppet module). Or modify this example:
For `nginx` configuration, there's two things you need to setup:
* The root `nginx.conf` file. We recommend using
`/etc/nginx/nginx.conf` from your Zulip server for our recommended
settings. E.g. if you don't set `client_max_body_size`, it won't be
possible to upload large files to your Zulip server.
* The `nginx` site-specific configuration (in
`/etc/nginx/sites-available`) for the Zulip app. You can look at
our [nginx reverse proxy configuration][nginx-loadbalancer] to see
an example of how to do this properly (the various include files are
available via the `zulip::nginx` puppet module). Or modify this
example:
```
map $http_upgrade $connection_upgrade {
@ -241,7 +248,8 @@ server {
```
Don't forget to update `server_name`, `ssl_certificate`,
`ssl_certificate_key` and `proxy_pass` with proper values.
`ssl_certificate_key` and `proxy_pass` with the appropriate values for
your installation.
[nginx-proxy-config]: https://github.com/zulip/zulip/blob/master/puppet/zulip/files/nginx/zulip-include-common/proxy
[nginx-proxy-longpolling-config]: https://github.com/zulip/zulip/blob/master/puppet/zulip/files/nginx/zulip-include-common/proxy_longpolling