Installing Sync server
Guide to install Sync server using Docker.
There is a public docker image at docker hub: https://hub.docker.com/r/soffid/iam-sync
Prerequisites
Soffid IAM sync server requires the following requirements:
Video Tutorial
Linux
Installation
To configure the first IAM Sync server, the following environment variables can be set for the first server:
Variable | Description | Example |
DB_URL | JDBC URL | jdbc:mariadb://dbcontainer/soffid |
DB_USER | Database user | Soffid |
DB_PASSWORD | Database password | 5uper5ecret |
SOFFID_HOSTNAME | The host name used to access to the sync server | syncserver01.soffid.com |
SOFFID_PORT | TCP port used for incomming connections | 760 |
SOFFID_MAIN | Set to yes for the first sync server, no for the next ones | yes |
To configure the next sync servers, the following environment variables can be set:
Variable | Description | Example |
SOFFID_SERVER | First sync server url | https://syncserver01.soffid.com:1760 |
SOFFID_USER | Soffid user to join the security domain | admin |
SOFFID_PASS | Soffid user password | changeit |
SOFFID_HOSTNAME | The host name used to access to the sync server | syncserver.soffid.com |
SOFFID_PORT | TCP port used for incomming connections | 760 |
SOFFID_TENANT | Tenant name | master |
SOFFID_MAIN | Set to yes for the first sync server, no for the next ones | no |
To configure a sync server in a private network, not directly accessible from the main sync server, the following environment variables can be set:
Variable | Description | Example |
SOFFID_SERVER | First sync server url | https://syncserver01.soffid.com:1760 |
SOFFID_USER | Soffid user to join the security domain | admin |
SOFFID_PASS | Soffid user password | changeit |
SOFFID_HOSTNAME | The host name used to access to the sync server | syncserver.soffid.com |
SOFFID_TENANT | Tenant name | master |
SOFFID_MAIN | Set to yes for the first sync server, no for the next ones | no |
SOFFID_REMOTE | Flag to enable cloud protocol | yes |
The following volumes are defined by default:
Volume | Usage |
/opt/soffid/iam-console-3/conf | Configuration files, including private keys and certificates |
Here you have a sample command to start a docker container running IAM sync server. Mind to specify the port number to expose the sync server docker to the outside world. It is not needed when using the cloud connectivity:
docker run -d \
-e DB_URL=jdbc:mysql://mariadb-service/soffid \
-e DB_USER=soffid \
-e DB_PASSWORD=soffid \
-e SOFFID_PORT=1760 \
-e SOFFID_HOSTNAME=syncserver.soffid.com \
-e SOFFID_MAIN=yes \
--name=iam-sync \
--publish 1760:1760 \
--network=soffidnet \
soffid/iam-sync
To see console log files, execute:
docker logs -f iam-sync