Overview

This section is for licensees inspecting the containers they are running and for engineers contributing fixes back upstream.

The Olympus source is provided under the Olympus Free Container License, you can inspect any container you have running, patch locally, and contribute fixes; you cannot redistribute modified source as a competing product.

Start here

• Inspecting your containers, how to read the source of a running container under the OFCL.
• Workspace setup, clone the eight repos as siblings, install Bun, configure the source-only @olympusoss/* packages.
• Package naming, why the npm packages are source-only and how that works.

Doing the work

• Running tests, per-repo test commands.
• Testing strategy, Vitest, Playwright, and mocked-Ory patterns.
• Working with Canvas, adding components, the source-only contract.
• Working with SDK, adding a new SDK module, the encryption format guarantees.

Shipping

• Release process, Changesets, version bumps, GHCR.
• Versioning, semver and the source-pin contract.

When something breaks

• Debugging OAuth2 flows
• Debugging Kratos flows

Contributing

• Contributing, how to submit a patch under the OFCL.