From 520953d0bdb957a6567b3eee98d6fbe1b6ffedfd Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Wed, 11 Oct 2023 13:54:59 +0200 Subject: [PATCH] enhancement(docs): add info about ports in the setup tutorial Signed-off-by: Erik Michelson --- docs/content/tutorials/setup.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/content/tutorials/setup.md b/docs/content/tutorials/setup.md index d9b57a8f4..129b2efe7 100644 --- a/docs/content/tutorials/setup.md +++ b/docs/content/tutorials/setup.md @@ -40,6 +40,20 @@ We will use [Docker][docker-docs] to accomplish this. 8. Navigate your browser to the url you chose in step 6. Your instance is now ready to use. + + +!!! info Using a different port + This tutorial assumes that you run your HedgeDoc 2 instance on port 80 and 443 (HTTP and HTTPS). + If you want to use a custom port, be sure to update your `.env` file to include the port in the + `HD_BASE_URL` variable as well as update the port bindings in the `docker-compose.yml` file. + For example, when using the base URL `http://localhost:8080`, only use the following ports + section for the `proxy` service: + ```yaml + ports: + - "8080:8080" + ``` + + You can now play around with your HedgeDoc instance and read about next steps