appdefs.xml

<!--
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, the
    default username/password to connect to the management interface are:
    [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>
      <section>
        <title level="2">Troubleshooting</title>
        <content/>
      </section>
      <section>
        <title level="3">Password Reset</title>
        <content>
The password of a user can be reset to `changeme` with the following command:

```
docker exec CONTAINER_NAME /opt/nginx-proxy-manager/bin/reset-password USER_EMAIL
```

Where:

  - `CONTAINER_NAME` is the name of the running container.
  - `USER_EMAIL` is the email of the address to reset the password.
        </content>
      </section>
    </documentation>
    <!-- Changelog of the application. -->
    <history>
      <release>
        <version>1.12.0</version>
        <date>2021-01-06</date>
        <change>Updated Nginx Proxy Manager to version 2.7.2.</change>
        <change>Added the GeoIP Nginx module.</change>
      </release>
      <release>
        <version>1.11.0</version>
        <date>2020-11-24</date>
        <change>Updated Nginx Proxy Manager to version 2.7.1.</change>
        <change>Fixed rotation of nginx log files.</change>
      </release>
      <release>
        <version>1.10.3</version>
        <date>2020-11-06</date>
        <change>Updated Nginx Proxy Manager to version 2.6.2.</change>
      </release>
      <release>
        <version>1.10.2</version>
        <date>2020-10-26</date>
        <change>Fixed generation of certificates that use DNS challenge.</change>
      </release>
      <release>
        <version>1.10.1</version>
        <date>2020-10-26</date>
        <change>Fixed automatic installation of Certbot plugins.</change>
      </release>
      <release>
        <version>1.10.0</version>
        <date>2020-10-25</date>
        <change>Updated Nginx Proxy Manager to version 2.6.1.</change>
        <change>Now using baseimage version 2.4.4, based on Alpine 3.12, which brings the following changes:</change>
        <change level="2">Upgraded glibc to version 2.31 on Alpine Linux images with glibc integrated.</change>
        <change level="2">Updated installed packages to get latest security fixes.</change>
        <change>Use sqlite as database instead of mariadb.</change>
        <change>Added proper support for the `DISABLE_IPV6` environment variable.</change>
        <change>Periodically clean Let's Encrypt certificates.</change>
      </release>
      <release>
        <version>1.9.2</version>
        <date>2020-07-10</date>
        <change>Fixed an issue where the container would fail to start if custom Nginx files are mounted by Docker.</change>
      </release>
      <release>
        <version>1.9.1</version>
        <date>2020-07-10</date>
        <change>Improved compatibility by disabling usage of SSE4.2 in OpenResty.</change>
      </release>
      <release>
        <version>1.9.0</version>
        <date>2020-07-09</date>
        <change>Upgraded Nginx Proxy Manager to version 2.3.1.</change>
      </release>
      <release>
        <version>1.8.1</version>
        <date>2020-05-21</date>
        <change>Upgraded Nginx Proxy Manager to version 2.2.4.</change>
      </release>
      <release>
        <version>1.8.0</version>
        <date>2020-04-15</date>
        <change>Upgraded Nginx Proxy Manager to version 2.2.3.</change>
      </release>
      <release>
        <version>1.7.4</version>
        <date>2020-04-08</date>
        <change>Fixed issue where generated proxy host config would use incorrect ports.</change>
      </release>
      <release>
        <version>1.7.3</version>
        <date>2020-04-07</date>
        <change>Upgraded Nginx Proxy Manager to version 2.2.2.</change>
      </release>
      <release>
        <version>1.7.2</version>
        <date>2020-04-06</date>
        <change>Fixed generation of resolvers.conf when IPv6 is involved.</change>
      </release>
      <release>
        <version>1.7.1</version>
        <date>2020-04-06</date>
        <change>Upgraded Nginx Proxy Manager to version 2.2.1.</change>
      </release>
      <release>
        <version>1.7.0</version>
        <date>2020-03-16</date>
        <change>Upgraded Nginx Proxy Manager to version 2.2.0.</change>
        <change>Now using baseimage v2.4.3, which brings the following changes:</change>
        <change level="2">Updated installed packages to get latest security fixes.</change>
        <change level="2">Make sure the tzdata is installed.</change>
      </release>
      <release>
        <version>1.6.0</version>
        <date>2019-10-10</date>
        <change>Rotate Nginx log files.</change>
        <change>Added tool to reset password of a user of the management interface.</change>
      </release>
      <release>
        <version>1.5.3</version>
        <date>2019-09-04</date>
        <change>Upgraded Nginx Proxy Manager to version 2.0.14.</change>
      </release>
      <release>
        <version>1.5.2</version>
        <date>2019-08-20</date>
        <change>Use baseimage based on Alpine 3.9.</change>
        <change level="2">This fixes TLS1.3 support.</change>
        <change>Keep the `fastcgi.conf` and `fastcgi_params` Nginx configuration files.</change>
      </release>
      <release>
        <version>1.5.1</version>
        <date>2019-07-02</date>
        <change>Fixed issue where the wrong SSL protocols/ciphers were used.</change>
      </release>
      <release>
        <version>1.5.0</version>
        <date>2019-05-09</date>
        <change>Upgraded Nginx Proxy Manager to version 2.0.13.</change>
        <change>Now using baseimage v2.4.2, which brings the following changes:</change>
        <change level="2">Updated installed packages to get latest security fixes.</change>
      </release>
      <release>
        <version>1.4.2</version>
        <date>2019-04-18</date>
        <change>Fixed issue where using a hostname for the upstream proxy host would not work.</change>
      </release>
      <release>
        <version>1.4.1</version>
        <date>2019-04-10</date>
        <change>Updated Nginx Proxy Manager to version 2.0.12.</change>
        <change>Fixed a directory traversal vulnerability.</change>
      </release>
      <release>
        <version>1.4.0</version>
        <date>2019-03-05</date>
        <change>Upgraded Nginx Proxy Manager version 2.0.11.</change>
      </release>
      <release>
        <version>1.3.1</version>
        <date>2019-02-21</date>
        <change>During startup, make sure there is no migration lock held.</change>
      </release>
      <release>
        <version>1.3.0</version>
        <date>2019-02-21</date>
        <change>Make sure to upgrade the database if required.</change>
        <change>Properly notify the supervisor when the database is ready.</change>
        <change>Make sure to not use the database directory if it was not initialized successfully.</change>
        <change>Upgraded Nginx Proxy Manager to version 2.0.9.</change>
        <change level="2">Fixed issue where HTTP/2 option could not be disabled.</change>
        <change level="2">Added HSTS settings.</change>
      </release>
      <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>
      <environment_variable>
        <name>DISABLE_IPV6</name>
        <description>When set to `1`, IPv6 support is disabled.  This is needed when IPv6 is not enabled/supported on the host.</description>
        <default>0</default>
        <unraid_template>
          <title>Disable IPv6</title>
          <description>When set to '1', IPv6 support is disabled.</description>
          <display>advanced</display>
          <required>false</required>
          <mask>false</mask>
        </unraid_template>
      </environment_variable>
    </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>