Deployment Guide


This guide will walk you through a production Synapse-Backup deployment. Synapse-Backup will register with AHA for service disovery and future devops tasks, and therefore this guide assumes the Synapse Deployment Guide has been followed.

As in the Synapse Deployment Guide, docker-compose will be used as a light-weight orchestration mechanism.


With the Synapse Deployment Guide completed, the following items will be needed before starting the deployment:

  • Access to the running AHA container.

  • The previously chosen network name; referred to as <yournetwork> in this guide.

  • A host prepared as specified by Prepare your Hosts.


If you are planning on using a backend besides the local filesystem for storing backups, review the DevOps Guide for additional details regarding that backend prior to deploying the Synapse-Backup service.


Inside the AHA container

Generate a one-time use provisioning URL:

python -m 00.backup

You should see output that looks similar to this:

one-time use URL: ssl://aha.<yournetwork>:27272/<guid>?certhash=<sha256>

On the Host

Create the container directory:

mkdir -p /srv/syn/00.backup/storage
chown -R 999 /srv/syn/00.backup/storage

Create the /srv/syn/00.backup/docker-compose.yaml file with contents:

version: "3.3"
    user: "999"
    image: vertexproject/synapse-backup:v2.x.x
    network_mode: host
    restart: unless-stopped
        - ./storage:/vertex/storage
        - SYN_BACKUP_HTTPS_PORT=null
        - SYN_BACKUP_AHA_PROVISION=ssl://aha.<yournetwork>:27272/<guid>?certhash=<sha256>


Don’t forget to replace your one-time use provisioning URL!

Start the container:

docker-compose --file /srv/syn/00.backup/docker-compose.yaml pull
docker-compose --file /srv/syn/00.backup/docker-compose.yaml up -d

Remember, you can view the container logs in real-time using:

docker-compose --file /srv/syn/00.backup/docker-compose.yaml logs -f

Add the Service to the Cortex

From a Storm console add the service to the Cortex:

> service.add backup aha://backup...

What’s next?

See the DevOps Guide for instructions on performing various maintenance tasks on your deployment!