Skip to content

Commit f5c6710

Browse files
jlesagejlesage
committed
Added template for Nginx Proxy Manager.
1 parent d67d048 commit f5c6710

File tree

1 file changed

+155
-0
lines changed

1 file changed

+155
-0
lines changed

‎appdefs.xml

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<!--
2+
Definitions for Nginx Proxy Manager docker container.
3+
4+
This file is used as data source to generate README.md and unRAID template files
5+
from Jinja2 templates.
6+
-->
7+
<defs>
8+
<app>
9+
<id>18</id>
10+
<gui_type>web</gui_type>
11+
<gui_port>8181</gui_port>
12+
<friendly_name>Nginx Proxy Manager</friendly_name>
13+
<name>{{ defs.app.friendly_name|lower|replace(' ', '-') }}</name>
14+
<project>
15+
<description>Nginx Proxy Manager enables you to easily forward to your websites running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.</description>
16+
<url>https://nginxproxymanager.jc21.com</url>
17+
</project>
18+
<unraid>
19+
<support_url>https://forums.unraid.net/topic/76460-support-nginx-proxy-manager/</support_url>
20+
<category>Network:Web Network:Proxy Tools:</category>
21+
<extra_description>
22+
[span style='color: red;'][b]Note:[/b][/span] For this container to be
23+
accessible from the internet, make sure ports [b]80[/b] and [b]443[/b] on
24+
the internet side of your router are properly forwarded to this container.
25+
See the documentation for more details.[br][br]
26+
[span style='color: red;'][b]Note:[/b][/span] After a fresh install, login
27+
to the management interface using the following credentials:
28+
[b]admin@example.com[/b]/[b]changeme[/b].
29+
</extra_description>
30+
</unraid>
31+
<container>
32+
<rough_download_size>100MB</rough_download_size>
33+
<unsupported_volume>/storage</unsupported_volume>
34+
</container>
35+
<!-- Extra stuff to be added to the documentation. -->
36+
<documentation>
37+
<section>
38+
<title level="2">Default Administrator Account</title>
39+
<content>
40+
After a fresh install, use the following credentials to login:
41+
- Email address: `admin@example.com`
42+
- Password: `changeme`
43+
44+
After you login with this default user, you will be asked to modify your details
45+
and change your password.
46+
</content>
47+
</section>
48+
<section>
49+
<title level="2">Accessibility From The Internet</title>
50+
<content>
51+
**NOTE:** This section assumes that the container is using the default `bridge`
52+
network type.
53+
54+
For this container to be accessible from the Internet, port forwarding must be
55+
configured on your router. This allows HTTP (port 80) and HTTPs (port 443)
56+
traffic from the Internet to reach this container on your private network.
57+
58+
Configuration of port forwarding differs from one router to another, but in
59+
general the same information must be configured:
60+
- **External port**: The Internet-side port to be forwarded.
61+
- **Internal port**: The port to forward to. Also called private port.
62+
- **Destination IP address**: The IP address of the device on the local
63+
network to forward to. Also called private IP address.
64+
65+
The IP address to forward to should be the IP address of the host running the
66+
container. The port to forward to should be the port mapped to the container
67+
during its creation (via the `-p` parameter of the `docker run` command).
68+
69+
Since the container needs to handle both HTTP and HTTPs traffic, two ports need
70+
to be forwarded:
71+
72+
| Traffic type | Container port | Host port mapped to container | External port | Internal port | Internal IP address |
73+
|--------------|----------------|-------------------------------|---------------|---------------|-----------------------------------------------|
74+
| HTTP | 8080 | XXXX | 80 | XXXX | IP address of the host running the container. |
75+
| HTTPs | 4443 | YYYY | 443 | YYYY | IP address of the host running the container. |
76+
77+
`XXXX` and `YYYY` are configurable port values. Unless they conflict with other
78+
used ports on the host, they can simply be set to the same value as the
79+
container port.
80+
81+
**NOTE**: Some routers don't offer the ability to configure the internal port
82+
to forward to. This means that internal port is the same as the external one.
83+
In a such scenario, `XXXX` must be set to `80` and `YYYY` to `443`.
84+
85+
For more details about port forwarding, see the following links:
86+
- [How to Port Forward - General Guide to Multiple Router Brands](https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/)
87+
- [How to Forward Ports on Your Router](https://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/)
88+
</content>
89+
</section>
90+
</documentation>
91+
<!-- Changelog of the application. -->
92+
<history>
93+
<release>
94+
<version>1.0.0</version>
95+
<date>2018-12-19</date>
96+
<change>Initial release.</change>
97+
</release>
98+
</history>
99+
</app>
100+
<container>
101+
<!-- Environment variables -->
102+
<environment_variables/>
103+
<!-- Volumes -->
104+
<volumes/>
105+
<!-- Network ports -->
106+
<ports>
107+
<port>
108+
<number>8181</number>
109+
<protocol>tcp</protocol>
110+
<description>Port used to access the web interface of the application.</description>
111+
<mandatory>true</mandatory>
112+
<unraid_template>
113+
<title>Web UI Port</title>
114+
<description>Port used to access the web interface of the application.</description>
115+
<default>{{ 7800 + defs.app.id|int }}</default>
116+
<display>always</display>
117+
<required>true</required>
118+
<mask>false</mask>
119+
</unraid_template>
120+
</port>
121+
<port>
122+
<number>8080</number>
123+
<protocol>tcp</protocol>
124+
<description>Port used to serve HTTP requests.</description>
125+
<mandatory>true</mandatory>
126+
<unraid_template>
127+
<title>HTTP Port</title>
128+
<description>Port used to serve HTTP requests.[br][b]NOTE:[/b] Your router should be configured to forward port [i]80[/i] to this port. If your router doesn't allow setting the destination/internal IP address, this [b][i]must[/i][/b] be set to [b]80[/b].</description>
129+
<default>{{ defs.app.id|int }}80</default>
130+
<display>always</display>
131+
<required>true</required>
132+
<mask>false</mask>
133+
</unraid_template>
134+
</port>
135+
<port>
136+
<number>4443</number>
137+
<protocol>tcp</protocol>
138+
<description>Port used to serve HTTPs requests.</description>
139+
<mandatory>true</mandatory>
140+
<unraid_template>
141+
<title>HTTPs Port</title>
142+
<description>Port used to serve HTTPs requests.[br][b]NOTE:[/b] Your router should be configured to forward port [i]443[/i] to this port. If your router doesn't allow setting the destination/internal IP address, this [b][i]must[/i][/b] be set to [b]443[/b].</description>
143+
<default>{{ defs.app.id|int }}443</default>
144+
<display>always</display>
145+
<required>true</required>
146+
<mask>false</mask>
147+
</unraid_template>
148+
</port>
149+
</ports>
150+
<!-- Devices -->
151+
<devices/>
152+
<!-- Extra parameters -->
153+
<extra_params/>
154+
</container>
155+
</defs>

0 commit comments

Comments
 (0)