From 8461023d4390acacd35426d831d0ab5f5fb158df Mon Sep 17 00:00:00 2001
From: zierbeek <58994651+zierbeek@users.noreply.github.com>
Date: Thu, 27 May 2021 01:04:29 +0200
Subject: [PATCH] Changing docs with reverse proxy (#436)

Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>
---
 docs/docs/community-guide/swag.md             | 87 +++++++++++++++++++
 .../developers-guide/starting-dev-server.md   |  1 +
 docs/mkdocs.yml                               |  1 +
 3 files changed, 89 insertions(+)
 create mode 100644 docs/docs/community-guide/swag.md

diff --git a/docs/docs/community-guide/swag.md b/docs/docs/community-guide/swag.md
new file mode 100644
index 000000000..68e1944da
--- /dev/null
+++ b/docs/docs/community-guide/swag.md
@@ -0,0 +1,87 @@
+# Using SWAG as Reverse Proxy
+
+To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag)  
+SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx web server and reverse proxy with PHP support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention.
+
+## Step 1: Get a domain
+
+The first step is to grab a dynamic DNS if you don't have your own subdomain already. You can get this from for example [DuckDNS](https://www.duckdns.org).
+
+## Step 2: Set-up SWAG
+
+Then you will need to set up SWAG, the variables of the docker-compose are explained on the Github page of [SWAG](https://github.com/linuxserver/docker-swag).
+This is an example of how to set it up using duckdns and docker-compose.
+
+!!! example "docker-compose.yml"
+```yaml
+version: "2.1"
+services:
+swag:
+image: ghcr.io/linuxserver/swag
+container_name: swag
+cap_add:
+- NET_ADMIN
+environment:
+- PUID=1000
+- PGID=1000
+- TZ=Europe/Brussels
+- URL=<mydomain.duckdns>
+- SUBDOMAINS=wildcard
+- VALIDATION=duckdns
+- CERTPROVIDER= #optional
+- DNSPLUGIN= #optional
+- DUCKDNSTOKEN=<duckdnstoken>
+- EMAIL=<e-mail> #optional
+- ONLY_SUBDOMAINS=false #optional
+- EXTRA_DOMAINS=<extradomains> #optional
+- STAGING=false #optional
+volumes:
+- /etc/config/swag:/config
+ports:
+- 443:443
+restart: unless-stopped
+
+```
+
+Don't forget to change the <code>mydomain.duckns</code> into your personal domain and the <code>duckdnstoken</code> into your token and remove the brackets.
+
+## Step 3: Change the config files
+
+Navigate to the config folder of SWAG and head to <code>proxy-confs</code>. If you used the example above, you should navigate to: <code>/etc/config/swag/nginx/proxy-confs/</code>.
+There are a lot of preconfigured files to use for different apps such as radarr,sonarr,overseerr,...
+
+To use the bundled configuration file, simply rename <code>mealie.subdomain.conf.sample</code> in the proxy-confs folder to <code>mealie.subdomain.conf</code>.
+Alternatively, you can create a new file <code>mealie.subdomain.conf</code> in proxy-confs with the following configuration:
+
+!!! example "mealie.subdomain.conf"
+```yaml
+    server {
+    listen 443 ssl http2;
+    listen [::]:443 ssl http2;
+
+    	server_name mealie.*;
+
+    	include /config/nginx/ssl.conf;
+
+    	client_max_body_size 0;
+
+    	location / {
+        	include /config/nginx/proxy.conf;
+        	include /config/nginx/resolver.conf;
+        	set $upstream_app mealie;
+        	set $upstream_port 80;
+        	set $upstream_proto http;
+        	proxy_pass $upstream_proto://$upstream_app:$upstream_port;
+    		}
+
+	}	
+```
+
+## Step 4: Port-forward port 443
+
+Since SWAG allows you to set up a secure connection, you will need to open port 443 on your router for encrypted traffic. This is way more secure than port 80 for http.
+
+## Step 5: Restart SWAG
+
+When you change anything in the config of Nginx, you will need to restart the container using <code>docker restart swag</code>.
+If everything went well, you can now access mealie on the subdomain you configured: mealie.mydomain.duckdns.org
diff --git a/docs/docs/contributors/developers-guide/starting-dev-server.md b/docs/docs/contributors/developers-guide/starting-dev-server.md
index 6b0db38c9..881f08830 100644
--- a/docs/docs/contributors/developers-guide/starting-dev-server.md
+++ b/docs/docs/contributors/developers-guide/starting-dev-server.md
@@ -40,6 +40,7 @@ docker-dev           Build and Start Docker Development Stack
 docker-prod          Build and Start Docker Production Stack
 code-gen             Run Code-Gen Scripts
 coverage             check code coverage quickly with the default Python
+
 ```
 
 ## Before you Commit! 
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 68685fa9d..99b575af0 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -68,6 +68,7 @@ nav:
           - Getting Started: "api-usage/getting-started.md"
           - Home Assistant: "api-usage/home-assistant.md"
           - Bulk Url Import: "api-usage/bulk-url-import.md"
+  - Community Guide: "community-guide/swag.md"
   - API Reference: "api/redoc.md"
   - Contributors Guide:
       - Non-Code: "contributors/non-coders.md"