Go to file

Claude Fable 5 28f05e270d All checks were successful CD / Build and push images (push) Successful in 1m5s Details CD / Deploy to Test (push) Successful in 9s Details CD / Smoke tests against Test (push) Successful in 1m6s Details CD / Promote to Int (push) Successful in 10s Details CI / Lint, typecheck, test (push) Successful in 3m33s Details CI / Build container images (push) Has been skipped Details Release / Build release images and notes (push) Successful in 1m1s Details Prod deploy / Deploy the released images to Prod (push) Successful in 14s Details CI / Auth e2e pack (push) Successful in 5m31s Details CI / Import/export fidelity gate (push) Successful in 47s Details Add the release pipeline with a tag-based manual gate and Prod stack (#89 ) Pushing vX.Y.Z builds the four semver images and publishes a Gitea release whose notes list the changes since the previous release with a migration call-out derived from the migrations diff (the repo is trunk-based — commit subjects stand in for PR titles). Deploying to Prod is a separate human act: pushing prod-vX.Y.Z-<suffix> — Gitea 1.22 has no environment approvals, so the tag push is the gate — verifies the release images exist, pins TAG in the Prod .env, restarts the stack, and waits for readiness; rollbacks are new suffix tags on the previous release. The Prod stage is provisioned on ONE (ports 8120-8122, secrets generated on the host, full backup profile); deploy/go-live.md carries the executed mechanics and the operator checklist that blocks the DNS switch (DNS, Caddy block, wizard/SMTP, legal texts, monitors, Prod drill, BASEL mirror). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EwZ4jR4KFAPvpjWevfUGX1		2026-07-12 00:17:13 +02:00
.gitea/workflows	Add the release pipeline with a tag-based manual gate and Prod stack (#89 )	2026-07-12 00:17:13 +02:00
apps	Format the social pack (#96 )	2026-07-12 00:02:12 +02:00
deploy	Add the release pipeline with a tag-based manual gate and Prod stack (#89 )	2026-07-12 00:17:13 +02:00
docs	Write the self-hosting guide and add the optional caddy TLS profile (#88 )	2026-07-11 21:21:10 +02:00
fixtures	Add import/export fidelity gate to CI (#69 )	2026-07-10 13:59:10 +02:00
packages	Batch notifications into localized e-mail digests with unsubscribe (#95 )	2026-07-11 23:37:26 +02:00
scripts	Add import/export fidelity gate to CI (#69 )	2026-07-10 13:59:10 +02:00
.dockerignore	Add production Dockerfiles and the Compose stack with dev overlay	2026-07-04 19:30:21 +02:00
.editorconfig	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
.gitignore	Add per-pond fonts: catalog, build, application, and admin UI (#66 )	2026-07-10 11:16:29 +02:00
.prettierignore	Add import/export fidelity gate to CI (#69 )	2026-07-10 13:59:10 +02:00
.prettierrc.json	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
eslint.config.mjs	Complete section-style plugins: CSS gate, injection, picker, export (#75 )	2026-07-11 11:43:36 +02:00
LICENSE	Add architecture documentation, ADRs, and operations concept	2026-07-04 14:36:16 +02:00
package.json	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00
pnpm-lock.yaml	Notify watchers about page changes and comments, with an in-app center (#94 )	2026-07-11 23:20:25 +02:00
pnpm-workspace.yaml	Complete section-style plugins: CSS gate, injection, picker, export (#75 )	2026-07-11 11:43:36 +02:00
README.md	Write the self-hosting guide and add the optional caddy TLS profile (#88 )	2026-07-11 21:21:10 +02:00
tsconfig.base.json	Scaffold pnpm monorepo with lint, format, and test tooling	2026-07-04 19:06:27 +02:00

README.md

Dorfteich

Dorfteich is an open-source wiki system built around ponds (German: Teiche) — self-contained wiki spaces that people and teams organize freely with hierarchical labels, directories, and Obsidian-style page relations. Pages are edited in a collaborative WYSIWYG editor with live cursors and offline support.

Project site: https://dorfteich.cloud
Public flagship instance: https://dorfteich.online
License: MIT

Key features

Real-time collaboration — multiple people edit the same page simultaneously; everyone sees the other participants' cursors and input live. Offline edits merge conflict-free on reconnect (CRDT-based).
Ponds — isolated wiki spaces with their own members, permissions, fonts, and page organization. Every registered person gets a personal pond.
Flexible organization — hierarchical labels, free page ordering, [[wikilinks]] with backlinks. A classic page tree is possible but never enforced.
Fine-grained permissions — roles (Site Admin, Pond Admin, Editor, Reader, Public) can be granted per pond, per label, or per page; the most specific setting wins.
Import & export — Markdown as the primary exchange format, plus best-effort structural import from Word/OpenOffice and export to Word/OpenOffice/PDF.
Plugins — sandboxed extensions (custom blocks, styles, page tools) installable at runtime without redeploying the instance.
Self-hosting first — a single docker compose up plus a guided first-run setup wizard yields a working instance. Start here: docs/self-hosting/README.md.

Repository layout

Path	Contents
`docs/architecture/`	Architecture documentation: ADRs, data model, permission model, collaboration and plugin concepts, deployment and operations
`docs/self-hosting/`	Install, update, backup, and troubleshooting guide for running your own instance
`apps/`	Application packages (web frontend, API server, collaboration server) — created as implementation proceeds
`packages/`	Shared packages (types, permission logic, plugin SDK)
`deploy/`	Docker Compose stacks and deployment tooling

Development

Requirements: Node.js ≥ 22 and pnpm (npm install -g pnpm).

pnpm install        # install all workspace dependencies
pnpm lint           # ESLint + Prettier check across the repo
pnpm typecheck      # TypeScript --noEmit in every package
pnpm test           # Vitest in every package
pnpm build          # build every package (dependency order)

The workspace packages live under apps/ (web, api, collab) and packages/ (shared). Shared logic goes into packages/shared and is imported as @dorfteich/shared — never copy code between apps.

Status

The project is in the architecture and backlog phase. Implementation stories are tracked as issues in this repository. Start reading at docs/architecture/README.md.

Contributing

Code, comments, and documentation are written in English. Write clear code that humans can follow easily; when in doubt, prefer readability over cleverness. All contributions are accepted under the MIT license.