Organization — 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 organization-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 organization/
cp -n main/config_templates/* main/config/
cp -n bff/config_templates/* bff/config/        # if using Web
cp -n api/config_templates/* api/config/        # if using API
cp -n scim/config_templates/* scim/config/      # if using SCIM

3. Configure

Each component requires a unique UUID. Generate and note these before opening any configuration files, as some are referenced across components:

uuidgen  # main
uuidgen  # api  (if using API)
uuidgen  # bff  (if using Web)

Main component

• Edit main/config/server.config — see server.config.

• Edit main/config/instance.properties — see instance.properties.

• Edit main/config/mailservice-credentials.properties — see mailservice-credentials.properties. (if using mailservice)
• Edit main/config/remote-storage-credentials.properties — see remote-storage-credentials.properties. (if using remote storage)

API component (optional)

• Edit api/config/ssi.properties — see ssi.properties.
• Edit api/config/instance.properties — see instance.properties.

Web component (optional)

• Edit bff/config/ssi.properties — see ssi.properties.
• Edit bff/config/instance.properties — see instance.properties.

SCIM component (optional)

• Edit scim/config/scim.properties — see scim.properties.

Info

For a complete example, see Examples.

4. Set up nginx

Run the nginx setup script to generate and apply the nginx configuration:

bash scripts/nginx-setup.sh

Info

Generates nginx configuration from templates using values from files under main/config, places the files under /etc/nginx, and restarts nginx.

5. Create compose file

cp compose-3.11.yaml compose.yaml

6. Validate configuration

bash scripts/validate-configuration.sh

7. 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

To start with API enabled:

docker compose --profile api up -d

To start with SCIM enabled:

docker compose --profile scim up -d

8. Verify installation

bash scripts/verify-installation.sh

9. Main administrator account

Retrieve the initial main administrator credentials:

cat main/appdata/admin.txt

Note

The password must be changed on first login. Proceed to the Administrator Guide for initial setup.