World — Installation
Ensure all prerequisites are completed before proceeding.
1. Extract the package
sudo mkdir -p /opt/synkzone
unzip -d /opt/synkzone world-3.11.zip
sudo chown -R synkzone: /opt/synkzone
su - synkzone && cd /opt/synkzone/world
Info
The installation package is provided by Synkzone. Contact your Synkzone sales representative to obtain access.
2. Copy configuration templates
cp --update=none world/config_templates/* world/config/
3. Configure
-
Generate a UUID:
uuidgen >> world/config/instance.properties -
Set the World FQDN — the FQDN you want on the certificates, not the machine's hostname.
If the server'shostnameisse-sto-002but you want it known asworld.example.com, setWorld=world.example.com— see server.config.ApplicationInstance=ex4mpl30-5c2e-4b8a-9f1d-3a7e6b4c2d8fWorld=world.example.com
4. Copy compose file
cp compose-3.11.yaml compose.yaml
5. Validate configuration
bash scripts/validate-configuration.sh
6. Start services
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. See World Certificate Bootstrap for the corresponding diagram.
- Start the World Server at least once to let it generate certificates and corresponding signing requests.
- Go to the
<appdata>/certificatesfolder on the World Server and make copies of theworld.csr,world_CA.csr, andworld.ksrsigning request files. It is IMPORTANT that these files are copied and not removed from the server. - Create a folder (named after the current date) in the zone in extern.synkzone.com.
- Add the signing request files to the folder.
- Request that Synkzone signs the certificates.
- When
world.pem,world_CA.pem, andworld.kechave been added to the zone, copy those files to the World Server<appdata>/certificatesfolder where the corresponding signing requests are still stored. - Start the World Server. This will cause the server to import the signed certificates, and then shut down again.
- Restart the World Server. After this restart the imported certificates will be ready for use.
8. Verify installation
bash scripts/verify-installation.sh