Created the english version of the reverse-proxy.md

2025-12-20 04:09:42 -06:00 · 2023-05-29 18:19:41 +02:00
parent a41465ea23
commit f5a0aff803
1 changed files with 103 additions and 0 deletions
--- a/docs/guides/reverse-proxy.en.md
+++ b/docs/guides/reverse-proxy.en.md
@@ -0,0 +1,103 @@
+This guide explains how to set up a reverse proxy with MySpeed using `apache` or `nginx`.
+
+!!! tip "Why use a reverse proxy?"
+    In this case we use a reverse proxy as an intermediate layer between you and MySpeed.
+    This has the advantage that you don't have to call MySpeed via a port, but via a normal domain.
+
+## Installation
+If you already have a reverse proxy installed, you can skip this step. Which of the two
+reverse proxies you want to use is up to you. However, we recommend `nginx` for this guide.
+
+=== "nginx"
+    ```sh
+    sudo apt-get install nginx -y
+    ```
+
+=== "apache"
+    ```sh
+    sudo apt-get install apache2 -y
+    ```
+
+## Configuring MySpeed
+
+This section explains how to connect MySpeed to your reverse proxy. Again, select here
+which reverse proxy you used.
+
+=== "nginx"
+    Now create a file named `myspeed.conf` under `/etc/nginx/sites-available`. Here we use `nano`
+    ```sh
+    sudo nano /etc/nginx/sites-available/myspeed.conf
+    ```
+    Now add the following content to the file:
+    ```nginx
+    server {
+        listen 80;
+        listen [::]:80;
+
+        server_name your-domain.com;
+
+        location / {
+            proxy_pass http://localhost:5216;
+        }
+    }
+    ```
+    Now you just have to activate the file and restart the reverse proxy.
+    ```sh
+    sudo ln -s /etc/nginx/sites-available/myspeed.conf /etc/nginx/sites-enabled/myspeed.conf
+    sudo systemctl restart nginx
+    ```
+
+=== "apache"
+    Now create a file named `myspeed.conf` under `/etc/apache2/sites-available`. Here we use `nano`
+    ```sh
+    sudo nano /etc/apache2/sites-available/myspeed.conf
+    ```
+    Now add the following content to the file:
+    ```apache
+    <VirtualHost *:80>
+        ServerName your-domain.com
+
+        ProxyPreserveHost On
+        ProxyPass / http://localhost:5216/
+        ProxyPassReverse / http://localhost:5216/
+    </VirtualHost>
+    ```
+    Now enable the `mod_proxy` and `mod_proxy_http` modules.
+    ```sh
+    sudo a2enmod proxy
+    sudo a2enmod proxy_http
+    ```
+    Now you just have to activate the file and restart the reverse proxy.
+    ```sh
+    sudo a2ensite myspeed.conf
+    sudo systemctl restart apache2
+    ```
+
+## Configuring an SSL certificate with Let's Encrypt
+
+This section explains how to set up an SSL certificate from Let's Encrypt for MySpeed.
+
+!!! tip "Are you using Cloudflare?"
+    If you use Cloudflare and don't want to set up an SSL certificate from Let's Encrypt, you can just use the
+    simply activate the Cloudflare proxy function. This is sufficient in most cases. If you
+    decide to use the Cloudflare proxy, you can skip this section.
+
+=== "nginx"
+    First you need to install certbot. For this we use `apt`.
+    ```sh
+    sudo apt-get install certbot python3-certbot-nginx -y
+    ```
+    Now you need to run Certbot and specify the domain you want to set up the certificate for.
+    ```sh
+    sudo certbot --nginx -d your-domain.com
+    ```
+
+=== "apache"
+    First you need to install certbot. For this we use `apt`.
+    ```sh
+    sudo apt-get install certbot python3-certbot-apache -y
+    ```
+    Now you need to run Certbot and specify the domain you want to set up the certificate for.
+    ```sh
+    sudo certbot --apache -d your-domain.com
+    ```