Skip to content

World — Installation

Ensure all prerequisites are completed before proceeding.

1. Extract the package

sudo mkdir -p /opt/synkzone
sudo chown $USER: /opt/synkzone
cd /opt/synkzone
unzip world-3.11.zip

Note

We recommend installing under /opt/synkzone, but you can use any directory you prefer.

Info

The installation package is provided by Synkzone. Contact your Synkzone sales representative to obtain access.

2. Copy configuration templates

cd world/
cp -n world/config_templates/* world/config/

3. Configure

Each component requires a unique UUID. Generate one with:

uuidgen

Edit world/config/instance.properties — see instance.properties.

Edit world/config/server.config — see server.config.

Edit world/config/mailservice-credentials.properties — see mailservice-credentials.properties. (if using mailservice)

Info

For a complete example, see Examples.

4. Create compose file

cp compose-3.11.yaml compose.yaml

5. Validate configuration

bash scripts/validate-configuration.sh

6. Start services

Warning

Before running the below commands ensure that the User & Group ID are set correctly if using bind mounts.

docker compose pull
docker compose up -d

7. Certificates

Synkzone needs to sign the initially created certificate requests, as well as the requests produced when the certificate should be extended.

  1. Start the World Server at least once to let it generate certificates and corresponding signing requests.
  2. Go to the <appdata>/certificates folder on the World Server and make copies of the world.csr, world_CA.csr, and world.ksr signing request files. It is IMPORTANT that these files are copied and not removed from the server.
  3. Create a folder (named after the current date) in the zone in extern.synkzone.com.
  4. Add the signing request files to the folder.
  5. Request that Synkzone signs the certificates.
  6. When world.pem, world_CA.pem, and world.kec have been added to the zone, copy those files to the World Server <appdata>/certificates folder where the corresponding signing requests are still stored.
  7. Start the World Server. This will cause the server to import the signed certificates, and then shut down again.
  8. Restart the World Server. After this restart the imported certificates will be ready for use.

8. Verify installation

bash scripts/verify-installation.sh