Public Demo
You are welcome to explore this solution. Prior to official go-live, you may use it freely — however, your data may be lost in future updates. No guarantees or liability are given. Use at your own discretion.
CommunityAdministrator

Operate Orkyo Community

Day-two operations for self-hosters — backups, upgrades, environment configuration, and the Community admin console.

Published

Once installed, a Community deployment needs the usual day-two care: backups, upgrades, and occasional configuration changes. The authoritative operations runbook ships with the software — the Operations guide in the orkyo-community repository — this page maps the territory.

Backup and restore

The operations guide covers database dumps and full restore, including the sharp edges (a restore requires stopping services and terminating lingering database connections before the database can be recreated). Two habits worth adopting from day one:

  • Schedule database dumps — the schedule data is the product; everything else is reproducible from images and configuration.
  • Test the restore path once before you need it in anger.

The in-app Export Data (JSON) under Organization settings complements — but does not replace — database backups.

Upgrades

An upgrade is a version-pin change: set ORKYO_VERSION to the new release, pull, and restart — via Portainer or the Compose CLI, whichever installed it. Migrations run automatically on start, and the operations guide includes verification steps. Read the release notes before jumping versions.

Configuration changes

Community is configured through environment variables at deployment time — the Configuration Reference documents the catalog: database, tenant identity, API, Keycloak, BFF authentication, SMTP, and frontend. Changing a value means updating the environment and redeploying; there is no in-app editor for platform configuration, which keeps the deployment reproducible.

The Community admin console

Site Admin (user menu) opens the deployment console — “Manage configuration, settings, and diagnostics for this deployment”:

  • Configuration — a read-only view pointing to the environment-variable model above.
  • Settings — deployment-level settings.
  • Audit Log — the same audit trail as SaaS, ungated.
  • Diagnostics — health information for troubleshooting.
  • Announcements — publish messages your users see under Messages.
  • Feedback — submissions from the in-app feedback button land here.

Day-to-day tenant administration — users, sites, organization, integrations — is the standard Administration area, identical in both editions.