diff options
| author | Alex Shnitman <alexta69@gmail.com> | 2021-10-14 19:13:03 +0300 |
|---|---|---|
| committer | Alex Shnitman <alexta69@gmail.com> | 2021-10-14 19:13:03 +0300 |
| commit | b8cd48e8d71b11fcf3ac7e8d2fc9686b6a488482 (patch) | |
| tree | dc5e2428b3b51572f8807db64e17902068efcc16 | |
| parent | docs: adds example of reverse proxy with Caddy (diff) | |
| download | metube-b8cd48e8d71b11fcf3ac7e8d2fc9686b6a488482.tar.gz metube-b8cd48e8d71b11fcf3ac7e8d2fc9686b6a488482.tar.bz2 metube-b8cd48e8d71b11fcf3ac7e8d2fc9686b6a488482.zip | |
Rewording of the reverse proxy section of the README
| -rw-r--r-- | README.md | 13 |
1 files changed, 9 insertions, 4 deletions
@@ -77,7 +77,13 @@ javascript:(function(){xhr=new XMLHttpRequest();xhr.open("POST","https://metube. ## Running behind a reverse proxy
-Use the following nginx configuration to run MeTube behind a reverse proxy. The extra `proxy_set_header` directives are there to make WebSocket work. Don't forget to set the URL_PREFIX environment variable to the correct value as well.
+It's advisable to run MeTube behind a reverse proxy, if authentication and/or HTTPS support are required.
+
+When running behind a reverse proxy which remaps the URL (i.e. serves MeTube under a subdirectory and not under root), don't forget to set the URL_PREFIX environment variable to the correct value.
+
+If you're using the [linuxserver/swag](https://docs.linuxserver.io/general/swag) image for your reverse proxying needs (which I can heartily recommend), it already includes ready snippets for proxying MeTube both in [subfolder](https://github.com/linuxserver/reverse-proxy-confs/blob/master/metube.subfolder.conf.sample) and [subdomain](https://github.com/linuxserver/reverse-proxy-confs/blob/master/metube.subdomain.conf.sample) modes under the `nginx/proxy-confs` directory in the configuration volume. It also includes Authelia which can be used for authentication.
+
+### NGINX
```
location /metube/ {
@@ -89,10 +95,9 @@ location /metube/ { }
```
-If you're using the [linuxserver/swag](https://docs.linuxserver.io/general/swag) image for your reverse proxying needs (which I can heartily recommend), it already includes ready snippets for proxying MeTube both in [subfolder](https://github.com/linuxserver/reverse-proxy-confs/blob/master/metube.subfolder.conf.sample) and [subdomain](https://github.com/linuxserver/reverse-proxy-confs/blob/master/metube.subdomain.conf.sample) modes under the `nginx/proxy-confs` directory in the configuration volume.
-
+Note: the extra `proxy_set_header` directives are there to make WebSocket work.
-### Reverse proxy using Caddy
+### Caddy
The following example Caddyfile gets a reverse proxy going behind [caddy](https://caddyserver.com)
|