Repository navigation
Home
Ordryn (formerly GoTodo) is a self-hosted project and task manager built with Go, PostgreSQL, Redis, and a Vue 3 UI. One binary serves either the web app plus the JSON API, or the API alone.
| Mode | Env / flag | Serves the Vue UI? | Typical use |
|---|---|---|---|
| full (default) |
ORDRYN_MODE=full or omit |
Yes, at / (or BASE_PATH) when web/dist is built |
Normal self-host |
| api |
ORDRYN_MODE=api or --mode=api
|
No | Headless hosts, mobile, and scripts |
ORDRYN_* variables also accept their older GOTODO_* names, so existing .env files keep working.
You only need this repository. Bundled extensions, the Android app, and example clients live in other repos and are optional.
- Self-hosting: install and first run
-
Building-the-server: stamp the git tag into the binary (
make build, systemd) -
Configuration:
.env, bootstrap, site overlay - Admin-settings: email, uploads and attachments, image hosting, GitHub, trash, and other settings kept in the database
-
Reverse-proxy: nginx,
BASE_PATH, HTTPS, live updates - Extensions: installing and enabling the bundled extensions
- Upgrading: migrations and required operator changes
- API: auth, keys, AI agents, MCP, and the OpenAPI contract
- Example-clients: sample programs in other repositories
- Local-development: Vite, tests, releasing
- Troubleshooting
The machine-readable API contract is openapi.yaml in the server repo. A running instance also serves it at GET /openapi.yaml, and a full mode site has in-app docs at /docs/api/v2.
Writing extension manifests (hooks, templates, settings scopes, sandboxed panels) is covered in the server README, not here. The wiki covers hosting.
Getting started
- Home
- Self-hosting
- Building-the-server
- Configuration
- Admin-settings
- Reverse-proxy
- Extensions
- Upgrading
Using the API
Help