An open API service indexing awesome lists of open source software.

https://github.com/Nico640/docker-unms

All-in-one docker image for Ubiquiti UISP (formerly UNMS). Supports x86_64 and ARM (Raspberry Pi).
https://github.com/Nico640/docker-unms

amd64 arm arm64 armhf docker docker-image raspberry-pi uisp unms x86-64

Last synced: 3 months ago
JSON representation

All-in-one docker image for Ubiquiti UISP (formerly UNMS). Supports x86_64 and ARM (Raspberry Pi).

Awesome Lists containing this project

README

          

[![GitHub Release](https://img.shields.io/github/v/release/Nico640/docker-unms?style=flat-square)](https://github.com/nico640/docker-unms/releases)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nico640/docker-unms/docker-release.yml?branch=master&style=flat-square)](https://github.com/Nico640/docker-unms/actions/workflows/docker-release.yml)

# Docker UISP (formerly UNMS)

This is an all-in-one Docker image for running the [Ubiquiti Network Management System](https://uisp.ui.com/). This image contains all the components required to run [UISP](https://uisp.ui.com/) in a single container and uses the [s6-overlay](https://github.com/just-containers/s6-overlay) for process management.

This image will run on most platforms that support Docker including [Docker for Mac](https://www.docker.com/docker-mac), [Docker for Windows](https://www.docker.com/docker-windows), Synology DSM and Raspberry Pi boards.

## Usage

```shell
docker run \
-p 80:80 \
-p 443:443 \
-p 2055:2055/udp \
-e TZ= \
-v :/config \
nico640/docker-unms:latest
```

## Raspberry Pi / ARM

This image will also allow you to run [UISP](https://uisp.ui.com/) 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 :/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 :/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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) 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

```yml
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
```