jokneemo/unimus repository overview

⁠Unimus Docker

Lightweight Docker container for Unimus⁠, a network automation and configuration management solution.

Available on:

• Server
  • Docker Hub: jokneemo/unimus⁠
  • GitHub Container Registry: ghcr.io/jokneemo/unimus⁠
• Core
  • Docker Hub: jokneemo/unimus-core⁠
  • GitHub Container Registry: ghcr.io/jokneemo/unimus-core⁠

⁠Docker Compose

⁠Unimus Server

name: unimus-server
services:
    unimus:
        image: jokneemo/unimus:latest # Docker Hub
        #image: ghcr.io/jokneemo/unimus:latest # GitHub Container Registry
        restart: unless-stopped
        ports:
            - "8085:8085" # Unimus Web UI
            - "5509:5509" # Unimus Core
        environment:
            TZ: America/New_York
            
            # Application Settings
            PROP_LICENSE_KEY: your-license-key
            PROP_DATABASE_ENCRYPTION_KEY: secure-encryption-key-string
            
            # Database Settings
            PROP_DATABASE_TYPE: POSTGRESQL
            PROP_DATABASE_HOST: postgres
            PROP_DATABASE_PORT: 5432
            PROP_DATABASE_NAME: unimus
            PROP_DATABASE_USER: unimus
            PROP_DATABASE_PASSWORD: database-password

    postgres:
        image: postgres:17-alpine
        restart: unless-stopped
        environment:
            POSTGRES_USER: unimus
            POSTGRES_PASSWORD: database-password
            POSTGRES_DB: unimus
        volumes:
            - ./postgres:/var/lib/postgresql/data

⁠Unimus Core

name: unimus-core
services:
    unimus-core:
        image: jokneemo/unimus-core:latest # Docker Hub
        #image: ghcr.io/jokneemo/unimus-core:latest # GitHub Container Registry
        restart: unless-stopped
        volumes:
            - /usr/share/zoneinfo/America/New_York:/etc/localtime:ro
        environment:
          TZ: America/New_York

          # Unimus Props (/etc/unimus-core/unimus-core.properties)
          PROP_UNIMUS_ADDRESS: 10.10.10.58
          PROP_UNIMUS_PORT: 5509
          PROP_UNIMUS_ACCESS_KEY: really_long_access_key_from_the_zone_of_this_core

          # Java Settings
          #JAVA_XMS: 512m
          #JAVA_XMX: 1024m
          #JAVA_OPTS:

⁠Configuration Variables

⁠Unimus Server Properties

Any setting in unimus.properties can be set via environment variables prefixed with PROP_. The container startup script automatically converts these variables:

1. Removes the PROP_ prefix.
2. Converts to lowercase.
3. Replaces underscores _ with dots ..

Example: PROP_DATABASE_HOST becomes database.host.

For a full list of available properties, see the Unimus Wiki⁠.

⁠Unimus Core Properties

Any setting in unimus-core.properties can be set via environment variables prefixed with PROP_. The container startup script automatically converts these variables:

1. Removes the PROP_ prefix.
2. Converts to lowercase.
3. Replaces underscores _ with dots ..

Example: PROP_UNIMUS_ADDRESS becomes unimus.address.

For a full list of available properties, see the Unimus Wiki⁠.

⁠Java Configuration

⁠System Configuration

⁠Unimus Server Defaults (Advanced)

You can configure system defaults (found in /etc/default/unimus) using environment variables prefixed with DEFAULT_. The conversion logic is the same as PROP_ variables:

1. Removes DEFAULT_ prefix.
2. Converts to lowercase.
3. Replaces underscores _ with dots ..

Important: For properties containing hyphens (e.g. discovery-disabled), you must use a hyphen in the environment variable name. This works in Docker Compose but may not be supported by all shells if running manually.

⁠Disabling Unimus Server Features

Common use cases for disabling specific Unimus Server features:

⁠Unimus Server Address

⁠File Generation

The container automatically generates configuration files at startup based on your environment variables. You can disable this behavior if you prefer to mount your own configuration files.

⁠Development Builds

Development builds of Unimus Server and Core are available by using the dev image tag.

image: jokneemo/unimus:dev
image: jokneemo/unimus-core:dev

These images are built automatically when a new public development build is available.