Technical documentation¶

How the SODa SCS Manager deployment is built, installed, and operated. For end-user how-tos see the User guide.

Start here¶

1. Glossary — terms used in this project (SCS, Keycloak, Traefik, naming, …).
2. Prerequisites — Docker, GitHub auth, .env.
3. Pre-start steps — start.sh, network, database, pre-install scripts.
4. Post-configuration checklist — Keycloak, Manager, Nextcloud, JupyterHub.

Sections¶

• Service infrastructure — stack layout, Traefik, shared DB, Manager, Drive, Code, OpenGDB, website.
• Architecture overview (C4 / Mermaid)
• Naming vocabulary — {scope}--{service}--{function}
• Naming migration plan
• SCS Manager user lifecycle
• Initial setup — before the first docker compose up
• Post-start — health checks after compose up
• Post-configuration — one-time service configuration
• Maintenance — updates and backups (update guide)
• Troubleshooting — common failures and test scripts

Reference¶

• Reverse proxy backend config
• Traefik labels and commands
• Dedicated WissKI deployment (Uni Graz)

Quick start¶

1. Clone the repository and initialize submodules.
2. Copy example-env to .env and set required variables (Prerequisites).
3. Run ./start.sh.
4. Run docker compose up -d.
5. Follow the post-configuration checklist.