Skip to content

📝(docs) clarify reverse proxy requirements for compose setup #1665

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
bcye wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📝(docs) clarify reverse proxy requirements for compose setup #1665

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
4 changes: 2 additions & 2 deletions docs/installation/compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,9 @@ FRONTEND_CSS_URL=https://storage.yourdomain.tld/themes/custom.css # custom css
> [!WARNING]
> In a production environment, configure SSL/TLS termination to run your instance on https.

If you have your own certificates and proxy setup, you can skip this part.
If you have your own certificates and proxy setup, you can skip this part. Docs is listening in the frontend container on port 8083 and further proxies requests to other containers as needed.

You can follow our [nginx proxy example](../examples/compose/nginx-proxy/README.md) with automatic generation and renewal of certificate with Let's Encrypt.
You can follow our [nginx proxy example](../examples/compose/nginx-proxy/README.md) with automatic generation and renewal of certificate with Let's Encrypt. The environment variables below are used by nginx-proxy as labels to automatically configure a proxy and don't affect the frontend service.

You will need to uncomment the environment and network sections in compose file and update it with your values.

Expand Down