246tech/unms repository overview

⁠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 UNMS⁠ in a single container and uses the s6-overlay⁠ for process management.

This image was created with UNRAID⁠ in mind where having the default ports just port forwarded by docker leaves UNMS partially crippled. 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 6080:6080 \
  -p 6443:6443 \
  -p 2055:2055/udp \
  -e TZ=<timezone> \
  -v </path/to/config>:/config \
  246tech/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 6080:6080 - Expose the HTTP web server port on the docker host
• -p 6443:6443 - 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=America/Barbados

Optional Settings:

• -e DEMO=false - Enable UNMS demo mode
• -e PUBLIC_HTTPS_PORT=6443 - This should match the HTTPS port your are exposing to on the docker host
• -e PUBLIC_WS_PORT=6443 - This should match the HTTPS port your are exposing to on the docker host
• -e SECURE_LINK_SECRET= - Random key for secure link module. Set this to something random.

⁠Limitations

The Docker image, 246tech/unms, is not maintained by or affiliated with Ubiquiti Networks. You should not expect any support from Ubiquiti when running UNMS using this image.

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

⁠Docker Compose

version: '2'
services:
  unms:
    image: 246tech/unms:latest  
    restart: always
    ports:
      - 6080:6080
      - 6443:6443
      - 2055:2055/udp
    environment:
      - TZ=America/Barbados
    volumes:
      - ./volumes/unms:/config