Updating Nginx Reverse Proxy documentation #743
Conversation
ravindk89
requested review from
krisis,
harshavardhana,
kannappanr and
djwfyi
| - A DNS hostname which uniquely identifies the MinIO deployment | ||
|
|
||
| There are two models for proxying requests to the MinIO Server API and the MinIO Console: | ||
|
|
There was a problem hiding this comment.
Choosing to not deal with :443 or https here. Not sure if that makes a difference.
| This documentation assumes the following: | ||
|
|
||
| - An existing `Nginx <http://nginx.org/en/download.html>`__ deployment | ||
| - An existing :ref:`MinIO <minio-installation>` deployment |
There was a problem hiding this comment.
This didn't resolve to a link. Is the reference correct?
There was a problem hiding this comment.
Fixed. I think I needed to re-update staging
|
|
||
| The following location blocks provide a template for further customization in your unique environment: | ||
|
|
||
| .. code-block:: shell |
There was a problem hiding this comment.
Pygments has nginx as a valid language format. I'd use that instead of shell for better highlighting.
There was a problem hiding this comment.
| listen [::]:80; | ||
| server_name minio.example.net; | ||
|
|
||
| # To allow special characters in headers |
There was a problem hiding this comment.
Drop the To in this and the other comment lines in the code sample.
Allow special characters in headers is fine.
| } | ||
| } | ||
|
|
||
| The S3 API signature calculation algorithm does *not* support proxy schemes where you host either the MinIO Server API or Console GUI on a subpath, e.g. ``example.net/s3/`` or ``example.net/s3/console``. |
There was a problem hiding this comment.
Can we drop the latinism e.g. and use the plain English for example or that is?
There was a problem hiding this comment.
such as could also work here to avoid repeating example.
|
|
||
| The following location blocks provide a template for further customization in your unique environment: | ||
|
|
||
| .. code-block:: shell |
There was a problem hiding this comment.
nginx for the language instead of shell.
|
|
||
| .. tab-item:: Subdomain | ||
|
|
||
| Create or configure a unique subdomain for both the MinIO Server S3 API and MinIO Console Web GUI. |
There was a problem hiding this comment.
I'd say for each of the here.
"for both" risks implying one subdomain is all that is needed.
Maybe
Create or configure separate, unique subdomains for the MinIO Server S3 API and for the MinIO Console Web GUI.
Separate and unique may be too much, but I think making subdomains plural really emphasizes they need two subdomains. I'll leave that to you to decide.
There was a problem hiding this comment.
Taking your suggestion!
|
Consider updating the NGINX link on this page to point to this topic. |
|
@djwfyi back to you - I have internal signoff on the engineering side. |
Closes #727
Staged: http://192.241.195.202:9000/staging/DOCS-727/integrations/setup-nginx-proxy-with-minio.html
Summary
With the websocket changes for MinIO Console, the existing nginx reverse proxy instructions need updating.
We also have run into a lot of users who have confusion on hosting MinIO on subpaths, which breaks the S3 signature calculation.
This PR handles both areas:
These docs make no reference on the nginx structure, because in my latest testing the whole
sites-availablesetup has vanished entirely for a simpler singledefaultfile you modify. We are comfortable letting Users take on the responsibility of being experts at nginx.