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

Install Orkyo Community

What self-hosting Orkyo takes — requirements, the two supported deployment paths, and where the authoritative install guide lives.

Published

Orkyo Community is the self-hosted, single-tenant edition: the full planning product, run on your own infrastructure with Docker. This page orients you; the authoritative, versioned installation guide lives with the software itself — the Community Quick Start in the orkyo-community repository — so instructions and release always match.

What you need

  • Docker 24+ with Docker Compose V2.
  • 2 GB RAM available to Docker.
  • Free ports for the frontend, API, and Keycloak (defaults 80/8080/9080; all overridable).
  • An SMTP server for system emails, and a public URL where users will reach the app.

The two supported paths

Both consume the same compose.yml from the repository’s release/ directory:

  • Portainer Stacks (recommended) — paste or point Portainer at the compose file, fill in the environment variables it prompts for, Deploy the stack.
  • Docker Compose CLI — a .env file plus docker compose up -d.

On first deploy, Keycloak imports its realm and the migrator runs database migrations — allow 2–3 minutes before the app answers.

Configuration is explicit — by design

Community follows a fail-fast rule: required settings have no defaults, and the deployment refuses to start until they are set. Expect to provide, among others: the Orkyo version to run, database and Keycloak credentials, a master encryption key (generated with openssl rand -base64 32), the app’s public URL, cookie domain, and SMTP settings. The Quick Start lists every required variable with its purpose, and the Configuration Reference covers the full catalog.

This is a feature, not friction: a Community deployment never silently runs with a default password.

After installation

  • Sign in, accept the Terms of Service, and walk the normal getting-started path — from here on, the product behaves exactly as this documentation describes for both editions.
  • For backups, upgrades, and the admin console, continue to Operate Orkyo Community.