From a4c85fed551acc9c1639ff35f76cf062a8cb2f1b Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 19 Dec 2021 13:54:18 -0500 Subject: [PATCH] feat(docs): add details of using NGINX Proxy Manager to the Reverse Proxy docs (#13) --- docs/content/doc/setup/reverse-proxies.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/content/doc/setup/reverse-proxies.md b/docs/content/doc/setup/reverse-proxies.md index 7d4cb1bb9..9c42ab3d3 100644 --- a/docs/content/doc/setup/reverse-proxies.md +++ b/docs/content/doc/setup/reverse-proxies.md @@ -80,6 +80,22 @@ server { NOTE: If you change the max upload size in Vikunja's settings, you'll need to also change the client_max_body_size in the nginx proxy config. +## NGINX Proxy Manager (NPM) + +1. Create a standard Proxy Host for the Vikunja Frontend within NPM and point it to the URL you plan to use. The next several steps will enable the Proxy Host to successfully navigate to the API (on port 3456). +2. Verify that the page will pull up in your browser. (Do not bother trying to log in. It won't work. Trust me.) +3. Now, we'll work with the NPM container, so you need to identify the container name for your NPM installation. e.g. NGINX-PM +4. From the command line, enter `sudo docker exec -it [NGINX-PM container name] /bin/bash` and navigate to the proxy hosts folder where the `.conf` files are stashed. Probably `/data/nginx/proxy_host`. (This folder is a persistent folder created in the NPM container and mounted by NPM.) +5. Locate the `.conf` file where the server_name inside the file matches your Vikunja Proxy Host. Once found, add the following code, unchanged, just above the existing location block in that file. (They are listed by number, not name.) +``` +location ~* ^/(api|dav|\.well-known)/ { + proxy_pass http://api:3456; + client_max_body_size 20M; + } +``` +6. After saving the edited file, return to NPM's UI browser window and refresh the page to verify your Proxy Host for Vikunja is still online. +7. Now, switch over to your Vikunja browswer window and hit refresh. If you configured your URL correctly in original Vikunja container, you should be all set and the browser will correctly show Vikunja. If not, you'll need to adjust the address in the top of the login subscreen to match your proxy address. + ## Apache Put the following config in `cat /etc/apache2/sites-available/vikunja.conf`: @@ -108,4 +124,4 @@ Put the following config in `cat /etc/apache2/sites-available/vikunja.conf`: **Note:** The apache modules `proxy`, `proxy_http` and `rewrite` must be enabled for this. -For more details see the [frontend apache configuration]({{< ref "install-frontend.md#apache">}}). \ No newline at end of file +For more details see the [frontend apache configuration]({{< ref "install-frontend.md#apache">}}).