aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-06-24 10:28:04 +0200
committerDanilo M. <danix@danix.xyz>2026-06-24 10:28:04 +0200
commit9c301a8eac944083556b3dce297764b4fca7d49a (patch)
tree5637367f51e28a240da82a27549c2aef5fb2b126 /README.md
parent02a5ae2adc2df39fc78fd7e29904ff473e9266a0 (diff)
downloadgitctl-9c301a8eac944083556b3dce297764b4fca7d49a.tar.gz
gitctl-9c301a8eac944083556b3dce297764b4fca7d49a.zip
docs: bring CLAUDE.md, README, TODO current after the three features
- CLAUDE.md: new hard rule that removal functions are exact inverses of their add counterparts (round-trip self-tests); TRASH_DIR added to the server constants; verified-live list extended with list-repos and a full delete cycle. - README: TRASH_DIR in the server-install constants and its dir note. - TODO: items 1-3 already marked done; cross-cutting work folded in; remaining leftovers listed (repo-name completion, the cosmetic No changes. echo, and the YAGNI gc-trash prune verb). - Removed all pre-existing em dashes from CLAUDE.md and README. Docs only, no code change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index cc25bb5..dbdaf1a 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@ chmod 644 /etc/cgitrc
```
Now authorize the helper key. **Do NOT add it to the git user's normal
-`~/.ssh/authorized_keys`** — gitolite owns and regenerates that file from its
+`~/.ssh/authorized_keys`**: gitolite owns and regenerates that file from its
keydir, so a hand-added line is wiped and, worse, an existing gitolite key may
match first and run `gitolite-shell` instead of the helper (you get
`FATAL: unknown git/gitolite command`).
@@ -130,9 +130,11 @@ ssh git_push info # gitolite access check
sudo install -m 755 -o root -g root gitctl-helper /usr/local/bin/gitctl-helper
```
2. Confirm the constants at the top of `gitctl-helper` match your server:
- `REPO_BASE`, `CGITRC`, `SYNC_SCRIPT`, `BACKUP_DIR`, `DEFAULT_OWNER`. The git
- user must be able to create `BACKUP_DIR` (default
- `/var/lib/gitolite3/cgitrc-backups`); it is made on first write.
+ `REPO_BASE`, `CGITRC`, `SYNC_SCRIPT`, `BACKUP_DIR`, `TRASH_DIR`,
+ `DEFAULT_OWNER`. The git user must be able to create `BACKUP_DIR` (default
+ `/var/lib/gitolite3/cgitrc-backups`) and `TRASH_DIR` (default
+ `/var/lib/gitolite3/trash`, where `repo delete` moves bare repos); both are
+ made on first write.
3. Authorize the helper key (see SSH setup, step 2).
4. Self-test the helper:
```