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