Docker¶

Docker-compose¶

Create a docker-compose.yml file:

version: '3.1'

services:
  enclave-fabric:
    container_name: fabric
    image: enclavenetworks/enclave:latest
    restart: always

    cap_add:
      - NET_ADMIN
    devices:
      - /dev/net/tun
    environment:
      ENCLAVE_ENROLMENT_KEY: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    volumes:
      - enclave-config:/etc/enclave/profiles
      - enclave-logs:/var/log/enclave

volumes:
  enclave-config:
  enclave-logs:

Replace XXXXX-XXXXX-XXXXX-XXXXX-XXXXX with your Default Enrolment Key
Bring the container up using docker-compose up -d
Verify Enclave is running insider the container with docker exec fabric enclave status

What to do if the install fails¶

For troubleshooting and errors, use the site search or visit our troubleshooting section to look for information about common error messages. If your installation fails and you are unable to resolve the problem by retrying, please contact support@enclave.io.

Staying up to date¶

The Enclave software and associated SaaS platform are updated together in tandem. Containers are immutable so any customers running Enclave inside a container may encounter a situation where our control plane and SaaS platform services are improved and new versions are released, but the version of Enclave running in their docker containers does not.

This is a situation we'd recommend our customers try to avoid by automatically, or manually establishing a process to ensure they're always running the latest version of Enclave inside a docker container.

We currently publish new versions of Enclave to synology-compat tag on Docker Hub, so we recommend using software like Watchtower alongside long-running containers to help ensure Enclave is automatically updated when new versions are released.

You may also consider using Diun, a CLI application to receive notifications when the Enclave image is updated on a Docker registry and manually pull the latest version.