Skip to main content

Docker

A Docker deployment guide leveraging Compose

This deployment method has the following prerequisites:

Login to registry​

Using the registry credentials you were given, login to:

docker login registry.synadia.io

Synadia Control Plane configuration file​

Create a file called syn-cp.yaml:

server:
  # full URL where you will access Control Plane
  url: http://localhost:8080

  # optional TLS certificates to enabled HTTPS
  # tls:
  #   cert_file: /path/to/cert.pem
  #   key_file: /path/to/key.pem

Docker Compose file​

Create a file called docker-compose.yaml with the following settings:

version: '3.9'

services:
  control-plane:
    container_name: control-plane
    image: registry.synadia.io/control-plane:latest
    hostname: control-plane
    command: ['server', 'start']
    volumes:
      - ./syn-cp.yaml:/app/syn-cp.yaml
      - control-plane-data:/app/data
    ports:
      - 8080:8080
      - 8443:8443
      # map port 6222 if using HA mode
      # 6222:6222

volumes:
  control-plane-data: {}

Start the containers​

Run the following command to bring up the stack.

docker compose up -d

Administrative credentials​

From version 1.4.3​

Set credentials on first access to the Web UI.

Till version 1.4.2​

On the initial startup, Control Plane's administrative credentials will be visible in the logs:

docker compose logs control-plane

Access the web UI​

By default, the Web UI is accessible on port 8080. This can be changed in the docker-compose.yaml.

Navigate to http://localhost:8080 or http://<your_docker_host>:8080.

Upgrade the image​

To upgrade Control Plane's image and restart, use the following commands:

docker compose pull control-plane
docker compose up -d

Stop the containers​

docker compose down

The container volume data can be deleted by including the -v option.

docker compose down -v

Third-party licenses​

The Control Plane image bundles open-source dependencies. See the Software Bill of Materials for the full inventory and license details across all Platform components.