Gå till innehållet

Organization — Installation

Ensure all prerequisites are completed before proceeding.

1. Extract the package

sudo mkdir -p /opt/synkzone
sudo unzip -d /opt/synkzone organization-3.11.zip
sudo chown -R synkzone: /opt/synkzone
su - synkzone && cd /opt/synkzone/organization

Info

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

2. Copy configuration templates

cp --update=none main/config_templates/* main/config/
cp --update=none bff/config_templates/* bff/config/        # if using Web
cp --update=none api/config_templates/* api/config/        # if using API
cp --update=none scim/config_templates/* scim/config/      # if using SCIM

3. Configure

  1. Generate a UUID for each component you're using:

    uuidgen >> main/config/instance.properties
uuidgen >> api/config/instance.properties   # if using API
uuidgen >> bff/config/instance.properties   # if using Web

  2. Configure the main component. See server.config.

  3. Configure the API component (optional). See ssi.properties.

  4. Configure the Web component (optional). See ssi.properties.

  5. Configure the SCIM component (optional). See scim.properties.

  6. Enable optional plugins — enabling Email is recommended.

4. Copy compose file

cp compose-3.11.yaml compose.yaml

5. Validate configuration

bash scripts/validate-configuration.sh

6. Set up the reverse proxy

See Reverse Proxy for the routing, header, and certificate requirements your reverse proxy must satisfy.

If you'd rather not configure one yourself, the included script sets up nginx for you:

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.

7. Start services

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.