All docs
On this page

Self-hosting

Run Kobun on your own infrastructure under the FSL-1.1-MIT licence.

Requirements

TODO — runtime, memory, and whether any persistent storage is needed at all. If drafts are stored server-side before publish, that is a storage requirement and belongs here.

Create a GitHub App

  1. TODO — where to create it, and under which account or organisation.
  2. TODO — the callback URL, which depends on where you’re hosting.
  3. TODO — the exact repository permissions required, and why each one is needed.
  4. TODO — generating and storing the private key.

Run it

TODO — replace with the real image name, tag and required environment variables.

# TODO — placeholder, not a working command.
docker run -p 3000:3000 \
  -e GITHUB_APP_ID=... \
  -e GITHUB_APP_PRIVATE_KEY=... \
  <image>

Environment

TODO — a table of every variable: name, whether it’s required, and what it does.

Put it behind a reverse proxy

TODO — TLS termination and any headers that must be forwarded for the OAuth callback to work.

Licensing

TODO — the homepage names FSL-1.1-MIT. State plainly what that permits for self-hosters, and what the MIT conversion date means in practice.

Upgrading

TODO — how to tell which version you’re running, and whether config or storage ever needs migrating between versions.