This guide will walk you through a production Synapse User Interface deployment.
The Synapse UI will register with
AHA for service discovery 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 Synapse UI deployment:
Access to the running
The previously chosen network name; referred to as
<yournetwork>in this guide.
A host prepared as specified by Prepare your Hosts.
SMTP server configuration options for invitation emails and password recovery.
netlocvalue comprised of the hostname and optional port that users will use to connect to the Synapse UI.
netloc refers to the hostname and optional port that the Synapse UI should expect to be reached via. It is used in
the generation of invitation emails and SAML authentication (if configured). An incorrect value will prevent users from registering
and logging in to the Synapse UI.
netloc defaults to
loop.vertex.link:4443 for test deployment purposes. In real deployments it
should be set appropriately to something such as
Replacing the automatically generated self-signed HTTPS certificate with your own is strongly recommended
in production deployments. The common name (CN) on the certificate should match your selected
See Use Custom HTTPS Certificates for more information.
We will use
<yournetloc> in the following configs to specify locations that should be replaced with your selected
Bootstrap an Admin User
An admin user account with a password is required to log in to the Synapse UI and invite other users.
The Synapse UI authenticates users via the Cortex it is connected to, so all Cortex users are Optic users without any extra configuration.
To add a new admin user to your connected Cortex, run the following command from inside the Cortex container:
python -m synapse.tools.moduser --add --admin true visi --passwd secret
Inside the AHA container
Generate a one-time use provisioning URL:
python -m synapse.tools.aha.provision.service 00.optic
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.optic/storage
chown -R 999 /srv/syn/00.optic/storage
/srv/syn/00.optic/docker-compose.yaml file with contents:
# SMTP configuration options
- [email protected] # The "from" address for emails sent by the application
Don’t forget to replace your one-time use provisioning URL!
Start the container:
docker-compose --file /srv/syn/00.optic/docker-compose.yaml pull
docker-compose --file /srv/syn/00.optic/docker-compose.yaml up -d
Remember, you can view the container logs in real-time using:
docker-compose --file /srv/syn/00.optic/docker-compose.yaml logs -f
Log in to the Synapse UI
The admin user created on the Cortex should now be able to log in to the Synapse UI
https://<yournetloc>. See the Log in to Optic docs for instructions on how to log in.
Add the Service to the Cortex
From the Console tool within the Synapse UI add the service to the Cortex:
> service.add optic aha://optic...
See the Devops Guide for instructions on performing various maintenance tasks on your deployment!
Invite other users
The Synapse UI provides a convenient way to manage users, roles and more.
After logging in as an admin user, navigate to the
Admin tool via the gear icon in the lower left corner of your screen.