From c40b9a8e200c45ea167fea80cb5860ed04996aa8 Mon Sep 17 00:00:00 2001
From: Amritanshu <git@tanshu.com>
Date: Sun, 18 Oct 2026 21:53:26 +0530
Subject: [PATCH] Fill in the empty readmes

Affine, Overleaf, and the registry had empty readmes, which the layout check now rejects.
---
 affine/playbook.yml |  2 +-
 affine/readme.md    | 19 +++++++++++++++++++
 overleaf/readme.md  | 18 ++++++++++++++++++
 registry/readme.md  | 18 ++++++++++++++++++
 4 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/affine/playbook.yml b/affine/playbook.yml
index 40e33dd..2571fb3 100755
--- a/affine/playbook.yml
+++ b/affine/playbook.yml
@@ -1,5 +1,5 @@
 #################################################
-# Setup Overleaf
+# Setup Affine
 #################################################
 ---
 - hosts: monoco
diff --git a/affine/readme.md b/affine/readme.md
index e69de29..07a8c60 100644
--- a/affine/readme.md
+++ b/affine/readme.md
@@ -0,0 +1,19 @@
+# Affine
+
+Runs [Affine](https://affine.pro) on `monoco` as Docker containers, with its
+state in the shared Postgres and Valkey units.
+
+## Variables
+
+- `host`: public hostname, `wiki.tanshu.com`.
+- `revision`: image tag, `stable` by default.
+- `db_password`: password for the `affine` database.
+
+Set them in [vars/default.yml](vars/default.yml).
+
+## Run
+
+    ansible-playbook playbook.yml
+
+The `affine-migration` role is commented out. Enable it for the first run and
+after a major version upgrade.
diff --git a/overleaf/readme.md b/overleaf/readme.md
index e69de29..71ca4dd 100644
--- a/overleaf/readme.md
+++ b/overleaf/readme.md
@@ -0,0 +1,18 @@
+# Overleaf
+
+Runs the [Overleaf Community Edition](https://github.com/overleaf/overleaf)
+`sharelatex` image on the hosts in `all`, with its state in the shared Mongo
+and Redis units.
+
+## Variables
+
+- `http_host`: public hostname, `latex.tanshu.com`.
+- `host_port`: host port, `3199`.
+- `sharelatex_image`: image name.
+- `mongo_container` and `redis_container`: the data services it expects.
+
+Set them in [vars/default.yml](vars/default.yml).
+
+## Run
+
+    ansible-playbook playbook.yml
diff --git a/registry/readme.md b/registry/readme.md
index e69de29..849d49c 100644
--- a/registry/readme.md
+++ b/registry/readme.md
@@ -0,0 +1,18 @@
+# Docker registry
+
+Runs the [distribution registry](https://distribution.github.io/distribution/)
+v3 on `clair`, behind the shared Caddy unit.
+
+## Variables
+
+- `host`: public hostname, `registry.tanshu.com`.
+- `username` and `password`: basic-auth credentials for pushes and pulls.
+- `docker_image`: registry image, `registry:3`.
+- `tracing_enabled`: set to `true` to enable the registry's tracing endpoint.
+
+Set them in [vars/default.yml](vars/default.yml). The password is a real
+credential, so move it to ansible-vault before this playbook is shared.
+
+## Run
+
+    ansible-playbook playbook.yml