How to set up?

Depending on your needs, of the following installation options can be suitable:

Setting up for evaluation/demo purposes

The following Docker Compose-based setup is intended for demo and evaluation purposes only and is not recommended for production use due to security and performance concerns. For the sake of installation simplicity, this setup contains a hard-coded JWT secret key, which is not secure. For enterprise grade setup, consider Kubernetes-based deployment of the provided containers (see Helm Chart), user_guide:100_deployment/dc.adoc[production compose setup], or other option available in your organization.
For RHEL with SELinux enabled runtime only

Allow the 389 (ldap) and 80 (frontend http) ports for usage in SELinux subsystem

sudo semanage port -a -t http_port_t -p tcp 80
sudo echo "net.ipv4.ip_unprivileged_port_start=80" >> /etc/sysctl.conf
sudo sysctl -p

In order to run the Governor locally, you need to

  1. Install Docker.

  2. Download and unzip governor-compose.zip. This file contains Docker Compose script as well as dumps of demo databases.

  3. Run the following commands in the unzipped directory:

docker compose pull
docker compose up

The UI will be available at http://localhost:80. Use the predefined username and password to log in for the first time: test@synthesized.io / Qq12345_.

Please note that connection details for demo source and target databases provided in the user interface (host transformed_db, port 5432) are valid for internal Docker Compose network. In order to access these databases from the host machine, you should use localhost as a hostname and port 5433.

(Optional) Setting up a volume for RocksDB

Synthesized TDK embedded into Governor relies on RocksDB embedded key-value store to speed up its performance. However, having RocksDB folder inside the container can lead to problems both with performance and space restrictions. In order to set up a volume on your local filesystem:

  • uncomment volumes section in docker-compose.yml

  • uncomment - [your path to rocksdb]:/app/rocksdb line and substitute your path to RocksDB folder.

  • make sure this folder is accessible for Docker using chmod 777 [your path to rocksdb] command.

(Optional) Setting up a volume for log files

If you are willing to store Governor log files locally instead having them in the container, do the following:

  • uncomment volumes section in docker-compose.yml

  • uncomment - [your path to logs]:/app/logs line and substitute your path to logs folder.

  • make sure this folder is accessible for Docker using chmod 777 [your path to logs] command.