nico640/docker-unms repository overview

⁠Docker UISP (formerly UNMS)

This is an all-in-one Docker image for running the Ubiquiti Network Management System⁠. This image contains all the components required to run UISP⁠ in a single container and uses the s6-overlay⁠ for process management.

This image will run on most platforms that support Docker including Docker for Mac⁠, Docker for Windows⁠, Synology DSM and Raspberry Pi boards.

⁠Usage

docker run \
  -p 80:80 \
  -p 443:443 \
  -p 2055:2055/udp \
  -e TZ=<timezone> \
  -v </path/to/config>:/config \
  nico640/docker-unms:latest

⁠Raspberry Pi / ARM

This image will also allow you to run UISP⁠ on a Raspberry Pi or other Docker-enabled ARMv7/8 devices.

docker run -d --name unms -p 80:80 -p 443:443 -p 2055:2055/udp -v </path/to/config>:/config nico640/docker-unms:latest

⁠Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.

• -v </path/to/config>:/config - The persistent data location, the database, certs and logs will be stored here
• -p 80:80 - Expose the HTTP web server port on the docker host
• -p 443:443 - Expose the HTTPS and WSS web server port on the docker host
• -p 2055:2055/udp - Expose the Netflow port on the docker host
• -e TZ - for timezone information⁠ e.g. -e TZ=Europe/London

Optional Settings:

• -e DEMO=false - Enable UISP demo mode
• -e PUBLIC_HTTPS_PORT=443 - This should match the HTTPS port your are exposing to on the docker host
• -e PUBLIC_WS_PORT=443 - This should match the HTTPS port your are exposing to on the docker host
• -e HTTPS_PORT=443 - Sets the HTTPS port the container's webserver is listening on
• -e HTTP_PORT=80 - Set ths HTTP port the container's webserver is listening on
• -e SSL_CERT= - Filename of custom SSL certificate in /config/usercert/
• -e SSL_CERT_KEY= - Filename of custom SSL key in /config/usercert/
• -e PUID=911 - User ID of the container user
• -e PGID=911 - Group ID of the container user

⁠Limitations

The Docker image, nico640/docker-unms, is not maintained by or affiliated with Ubiquiti Networks. You should not expect any support from Ubiquiti when running UISP (formerly UNMS) using this image.

• In-app upgrades will not work. You can upgrade UISP by downloading the latest version of this image.

⁠Docker Compose

version: '2'
services:
  unms:
    image: nico640/docker-unms:latest
    restart: always
    ports:
      - 80:80
      - 443:443
      - 2055:2055/udp
    environment:
      - TZ=Australia/Sydney
    volumes:
      - ./volumes/unms:/config