open, visual documentation
649
Open, visual documentation: step-by-step guides with annotated photos, organised in a category tree, self-hosted for one organisation.
Source, issues and full documentation: https://git.mike-ochmann.de/MassiveDynamic/kataba
| Tag | Points to |
|---|---|
1.0.1 | exactly this release |
latest | the latest release |
Images are built for linux/amd64 and linux/arm64. What changed in each release: CHANGELOG.md.
kataba needs a MariaDB database and an Authentik OIDC application. UPLOAD_DIR is preset to the volume /data/uploads:
docker run -d --name kataba -p 3000:3000 \
-v kataba-uploads:/data/uploads \
-e DATABASE_URL="mysql://kataba:secret@db-host:3306/kataba" \
-e AUTH_URL="https://kataba.example.com" \
-e AUTH_SECRET="…" \
-e AUTH_AUTHENTIK_ID="…" -e AUTH_AUTHENTIK_SECRET="…" \
-e AUTH_AUTHENTIK_ISSUER="https://authentik.example.com/application/o/kataba/" \
mikognn/kataba:1.0.1
An example Docker Compose setup with MariaDB is in docker/. To use this image there, replace the build: section of the kataba service with image: mikognn/kataba:1.0.1.
| Variable | Description |
|---|---|
DATABASE_URL | MariaDB connection string |
AUTH_URL | The public URL of the instance |
AUTH_SECRET | Secret for signing sessions, e.g. from npx auth secret |
AUTH_AUTHENTIK_ID | Client ID of the Authentik OIDC application |
AUTH_AUTHENTIK_SECRET | Client secret of the Authentik OIDC application |
AUTH_AUTHENTIK_ISSUER | Issuer URL of the Authentik application |
KATABA_ADMIN_GROUP | Authentik group whose members become admins (default kataba-admins) |
KATABA_AUTHOR_GROUP | Authentik group whose members become authors (default kataba-authors) |
KATABA_SKIP_MIGRATIONS | 1 turns off the migrations the container applies on every start |
In Authentik, set the redirect URI to https://<your-host>/api/auth/callback/authentik, the scopes to openid, email and profile, and make sure the token carries a groups claim.
node user. Put a TLS-terminating reverse proxy in front of it./data/uploads volume together with the database.Licensed under the MIT License.
Content type
Image
Digest
sha256:52441b881…
Size
179.2 MB
Last updated
10 days ago
docker pull mikognn/kataba