Skip to content

Commit 0eb5699

Browse files
committed
Format files
1 parent e4b70ce commit 0eb5699

16 files changed

+52
-51
lines changed

.editorconfig

+1
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ trim_trailing_whitespace = false
1111
[{*.conf,*.conf.sample}]
1212
indent_style = space
1313
indent_size = 4
14+
trim_trailing_whitespace = true

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# How to use these Reverse Proxy Configs
44

5-
This folder contains sample reverse proxy configs for various docker images linuxserver provides and other commonly used applications.
5+
This folder contains sample reverse proxy configs for various docker images linuxserver provides and other commonly used applications.
66

77
NOTE: We avoid providing samples that publicly expose server management software (ex: syno, qnap, unraid, proxmox, esxi, etc). Pull requests to add samples for this category of applications will not be accepted.
88

@@ -23,27 +23,27 @@ Conversely subdomain reverse proxying does not require special accommodation by
2323

2424
Make sure that your default site config contains the following lines in the appropriate spots as seen in the default version:
2525

26-
1) For subfolder methods: `include /config/nginx/proxy-confs/*.subfolder.conf;`
27-
2) For subdomain methods: `include /config/nginx/proxy-confs/*.subdomain.conf;`
26+
1. For subfolder methods: `include /config/nginx/proxy-confs/*.subfolder.conf;`
27+
2. For subdomain methods: `include /config/nginx/proxy-confs/*.subdomain.conf;`
2828

2929
### Ensure you have a custom docker network
3030

31-
These confs assume that the swag container can reach other containers via their dns hostnames (defaults to container name) resolved via docker's internal dns. This is achieved through having the containers attached to the same user defined docker bridge network.
31+
These confs assume that the swag container can reach other containers via their dns hostnames (defaults to container name) resolved via docker's internal dns. This is achieved through having the containers attached to the same user defined docker bridge network.
3232

3333
- If you are using docker-compose and the containers are managed through the same yaml file, docker-compose will automatically create a custom network and attach all containers to it. Nothing extra is required.
3434

3535
- If you are starting the containers via command line, first create a bridge network with the command `docker network create [networkname]` Then define that network in the container run/create command via `--network [networkname]`.
3636

3737
- If you are using a gui manager like portainer, you can create a custom bridge network in the gui, and select it when creating a new container.
3838

39-
- If you are using unraid, create a custom network in command line via `docker network create [networkname]`, then go to docker service settings (under advanced) and set the option `Preserve user defined networks:` to `Yes`. Then in each container setting, including the swag container, in the network type dropdown, select `Custom : [networkname]`. This is a necessary step as the bridge network that unraid uses by default does not allow container to container communication.
39+
- If you are using unraid, create a custom network in command line via `docker network create [networkname]`, then go to docker service settings (under advanced) and set the option `Preserve user defined networks:` to `Yes`. Then in each container setting, including the swag container, in the network type dropdown, select `Custom : [networkname]`. This is a necessary step as the bridge network that unraid uses by default does not allow container to container communication.
4040

4141
If the reverse proxied containers are not reachable via dns or they are running on a different machine, you will have to modify these confs to fit your needs.
4242

4343
### Rename the required proxy configs
4444

45-
1) Rename the conf files and remove the `.sample` at the end (ie. `sonarr.subfolder.conf`)
46-
2) Restart the swag container
45+
1. Rename the conf files and remove the `.sample` at the end (ie. `sonarr.subfolder.conf`)
46+
2. Restart the swag container
4747

4848
### Make any necessary changes detailed in the config
4949

calibre-web.subdomain.conf.sample

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ server {
4848
proxy_set_header X-Scheme $scheme;
4949
}
5050

51-
# OPDS feed for eBook reader apps
52-
# Even if you use Authelia, the OPDS feed requires a password to be set for
53-
# the user directly in Calibre-Web, as eBook reader apps don't support
54-
# form-based logins, only HTTP Basic auth.
51+
# OPDS feed for eBook reader apps
52+
# Even if you use Authelia, the OPDS feed requires a password to be set for
53+
# the user directly in Calibre-Web, as eBook reader apps don't support
54+
# form-based logins, only HTTP Basic auth.
5555
location /opds/ {
5656
include /config/nginx/proxy.conf;
5757
include /config/nginx/resolver.conf;

crowdsec.subdomain.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ server {
4141
set $upstream_port 8080;
4242
set $upstream_proto http;
4343
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
44-
44+
4545
}
4646
}

komga.subfolder.conf.sample

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ location ^~ /komga/ {
3030

3131
}
3232

33-
location ^~ /komga/api {
34-
include /config/nginx/proxy.conf;
35-
include /config/nginx/resolver.conf;
36-
set $upstream_app komga;
37-
set $upstream_port 8080;
38-
set $upstream_proto http;
39-
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
40-
}
33+
location ^~ /komga/api {
34+
include /config/nginx/proxy.conf;
35+
include /config/nginx/resolver.conf;
36+
set $upstream_app komga;
37+
set $upstream_port 8080;
38+
set $upstream_proto http;
39+
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
40+
}

mailu.subfolder.conf.sample

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# This config have been tested with "TLS_FLAVOR=mail"
66
# To avoid errors you must change in docker-compose ports: 80 and 443, more info: https://mailu.io/1.7/reverse.html
77

8-
location /admin{
8+
location /admin {
99
return 301 $scheme://$host/admin/;
1010
}
1111

@@ -32,7 +32,7 @@ location ^~ /admin/ {
3232

3333
}
3434

35-
location /webmail{
35+
location /webmail {
3636
return 301 $scheme://$host/webmail/;
3737
}
3838

mytinytodo.subfolder.conf.sample

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ location /todo {
99
}
1010

1111
location ^~ /todo/ {
12-
1312
# enable the next two lines for http auth
1413
#auth_basic "Restricted";
1514
#auth_basic_user_file /config/nginx/.htpasswd;

nextcloud.subfolder.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ location ^~ /.well-known {
1818
# in the Nextcloud `.htaccess` that concern `/.well-known`.
1919

2020
location = /.well-known/carddav { return 301 /nextcloud/remote.php/dav/; }
21-
location = /.well-known/caldav { return 301 /nextcloud/remote.php/dav/; }
21+
location = /.well-known/caldav { return 301 /nextcloud/remote.php/dav/; }
2222

2323
# Let Nextcloud's API for `/.well-known` URIs handle all other
2424
# requests by passing them to the front-end controller.

ombi.subdomain.conf.sample

+5-5
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ server {
5353
set $upstream_proto http;
5454
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
5555

56-
}
56+
}
5757

5858
# This allows access to the documentation for the api
5959
location ~ (/ombi)?/swagger {
@@ -64,9 +64,9 @@ server {
6464
set $upstream_proto http;
6565
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
6666

67-
}
67+
}
6868

69-
if ($http_referer ~* /ombi) {
70-
rewrite ^/swagger/(.*) /ombi/swagger/$1? redirect;
71-
}
69+
if ($http_referer ~* /ombi) {
70+
rewrite ^/swagger/(.*) /ombi/swagger/$1? redirect;
71+
}
7272
}

qbittorrent.subdomain.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ server {
121121
proxy_set_header Host $upstream_app:$upstream_port;
122122
proxy_set_header X-Forwarded-Host $host;
123123
}
124-
124+
125125
location ~ (/qbittorrent)?/scripts {
126126
include /config/nginx/proxy.conf;
127127
include /config/nginx/resolver.conf;

rclone.subfolder.conf.sample

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ location ^~ /rclone/ {
3030
rewrite /rclone(.*) $1 break;
3131
}
3232

33-
location ^~ /rclone/websockify {
34-
include /config/nginx/proxy.conf;
35-
include /config/nginx/resolver.conf;
36-
set $upstream_app rclone;
37-
set $upstream_port 5800;
38-
set $upstream_proto http;
39-
proxy_pass $upstream_proto://$upstream_app:$upstream_port/websockify/;
33+
location ^~ /rclone/websockify {
34+
include /config/nginx/proxy.conf;
35+
include /config/nginx/resolver.conf;
36+
set $upstream_app rclone;
37+
set $upstream_port 5800;
38+
set $upstream_proto http;
39+
proxy_pass $upstream_proto://$upstream_app:$upstream_port/websockify/;
4040

4141
rewrite /rclone(.*) $1 break;
42-
}
42+
}

sonarr.subdomain.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ server {
5252
set $upstream_proto http;
5353
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
5454

55-
}
55+
}
5656
}

transmission.subdomain.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ server {
5151
set $upstream_proto http;
5252
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
5353

54-
proxy_pass_header X-Transmission-Session-Id;
54+
proxy_pass_header X-Transmission-Session-Id;
5555
}
5656

5757
location ~ (/transmission)?/rpc {

transmission.subfolder.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ location ^~ /transmission {
3333
set $upstream_proto http;
3434
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
3535

36-
proxy_pass_header X-Transmission-Session-Id;
36+
proxy_pass_header X-Transmission-Session-Id;
3737
}
3838

3939
location ^~ /transmission/rpc {

tvheadend.subfolder.conf.sample

+10-9
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
# make sure that your tvheadend container is named tvheadend
33
# make sure that tvheadend is set to work with the base url /tvheadend/
44
# Before activating this config you need to do two things:
5-
# - enable a setting in the tvheadend web interface
6-
# - change your RUN_OPTS for tvheadend.
5+
# - enable a setting in the tvheadend web interface
6+
# - change your RUN_OPTS for tvheadend.
77
#
88
# You need to enable the setting "PROXY protocol & X-Forwarded For"
9-
# in the tvheadend web interface. This setting can be found in
10-
# "Configuration" -> "General" -> "Base" in the "HTTP Server Settings" Group.
11-
# You need to set the View level to Expert to see it. Once activated, you may need to
12-
# restart your tvheadend container. When testing this config, please be reminded
13-
# that the tvheadend docker can take a very long time to start (>10mins).
14-
#
15-
# For the subfolder to work you also need to edit your tvheadend docker compose / cli config
9+
# in the tvheadend web interface. This setting can be found in
10+
# "Configuration" -> "General" -> "Base" in the "HTTP Server Settings" Group.
11+
# You need to set the View level to Expert to see it. Once activated, you may need to
12+
# restart your tvheadend container. When testing this config, please be reminded
13+
# that the tvheadend docker can take a very long time to start (>10mins).
14+
#
15+
# For the subfolder to work you also need to edit your tvheadend docker compose / cli config
1616
# and set http_root in RUN_OPTS to tvheadend, e.g. in docker compose:
1717
# - RUN_OPTS= --http_root /tvheadend
1818

@@ -33,6 +33,7 @@ location /tvheadend/ {
3333

3434
# enable for Authentik (requires authentik-server.conf in the server block)
3535
#include /config/nginx/authentik-location.conf;
36+
3637
include /config/nginx/proxy.conf;
3738
include /config/nginx/resolver.conf;
3839

youtube-dl.subfolder.conf.sample

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ location ^~ /youtube-dl/ {
2323

2424
include /config/nginx/proxy.conf;
2525
include /config/nginx/resolver.conf;
26-
set $upstream_app youtube-dl-server;
26+
set $upstream_app youtube-dl-server;
2727
set $upstream_port 8080;
2828
set $upstream_proto http;
2929
proxy_pass $upstream_proto://$upstream_app:$upstream_port;

0 commit comments

Comments
 (0)