Skip to content

Commit

Permalink
Allow including custom nginx conf files (#178)
Browse files Browse the repository at this point in the history
* Allow including custom nginx conf files

Give advanced users more flexibility by allowing them to include custom config files at differents locations in the nginx configuration.

`/data/nginx/custom/root.conf`: Included at the very end of nginx.conf
`/data/nginx/custom/http.conf`: Included at the end of the main `http` block
`/data/nginx/custom/server_proxy.conf`: Included at the end of every proxy `server` block
`/data/nginx/custom/server_redirect.conf`: Included at the end of every redirection `server` block
`/data/nginx/custom/server_stream.conf`: Included at the end of every stream `server` block
`/data/nginx/custom/server_stream_tcp.conf`: Included at the end of every TCP stream `server` block
`/data/nginx/custom/server_stream_udp.conf`: Included at the end of every UDP stream `server` block

* Don't fail if file doesn't exist

* Advanced Nginx settings doc
  • Loading branch information
cmer authored and jc21 committed Aug 9, 2019
1 parent ddbfdf6 commit 31aa9c9
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 0 deletions.
17 changes: 17 additions & 0 deletions doc/ADVANCED_NGINX.md
@@ -0,0 +1,17 @@
## Advanced Nginx Configuration

If you are a more advanced user, you might be itching for extra Nginx customizability.

NPM has the ability to include different custom configuration snippets in different places.

You can add your custom configuration snippet files at `/data/nginx/custom` as follow:

`/data/nginx/custom/root.conf`: Included at the very end of nginx.conf
`/data/nginx/custom/http.conf`: Included at the end of the main http block
`/data/nginx/custom/server_proxy.conf`: Included at the end of every proxy server block
`/data/nginx/custom/server_redirect.conf`: Included at the end of every redirection server block
`/data/nginx/custom/server_stream.conf`: Included at the end of every stream server block
`/data/nginx/custom/server_stream_tcp.conf`: Included at the end of every TCP stream server block
`/data/nginx/custom/server_stream_udp.conf`: Included at the end of every UDP stream server block

Every file is optional.
5 changes: 5 additions & 0 deletions rootfs/etc/nginx/nginx.conf
Expand Up @@ -76,10 +76,15 @@ http {
include /data/nginx/redirection_host/*.conf;
include /data/nginx/dead_host/*.conf;
include /data/nginx/temp/*.conf;

# Custom
include /data/nginx/custom/http[.]conf;
}

stream {
# Files generated by NPM
include /data/nginx/stream/*.conf;
}

# Custom
include /data/nginx/custom/root[.]conf;
2 changes: 2 additions & 0 deletions src/backend/templates/proxy_host.conf
Expand Up @@ -41,5 +41,7 @@ server {
}
{% endif %}

# Custom
include /data/nginx/custom/server_proxy[.]conf;
}
{% endif %}
2 changes: 2 additions & 0 deletions src/backend/templates/redirection_host.conf
Expand Up @@ -25,5 +25,7 @@ server {
}
{% endif %}

# Custom
include /data/nginx/custom/server_redirect[.]conf;
}
{% endif %}
8 changes: 8 additions & 0 deletions src/backend/templates/stream.conf
Expand Up @@ -7,12 +7,20 @@
server {
listen {{ incoming_port }};
proxy_pass {{ forward_ip }}:{{ forwarding_port }};

# Custom
include /data/nginx/custom/server_stream[.]conf;
include /data/nginx/custom/server_stream_tcp[.]conf;
}
{% endif %}
{% if udp_forwarding == 1 or udp_forwarding == true %}
server {
listen {{ incoming_port }} udp;
proxy_pass {{ forward_ip }}:{{ forwarding_port }};

# Custom
include /data/nginx/custom/server_stream[.]conf;
include /data/nginx/custom/server_stream_udp[.]conf;
}
{% endif %}
{% endif %}

0 comments on commit 31aa9c9

Please sign in to comment.