mi/werkator
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: explain the optional repo-add name

Browse Source
This commit is contained in:
mhoennig
2026-09-05 14:04:12 +02:00
parent c6e2155485
commit 9e5885907c
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -18,6 +18,8 @@ tools/remote --env-file .env.<instance> werkator repo-add https://gitea.example.
``` ```
It prints the registry entry: add it to `~/.werkator.yml` under `repositories:`, then restart the service. It prints the registry entry: add it to `~/.werkator.yml` under `repositories:`, then restart the service.
The optional `[<name>]` overrides the directory basename: it becomes the route segment (`/repos/<name>/…`) and the UI switcher entry, so it must be unique.
Needed only when the clone directory name is wrong or collides — e.g. `michael.hoennig.de.git` checked out as `michael.hoennig.de`, or two forges serving a repo of the same name.
A **public** repository needs nothing else: the clone runs anonymously. A **public** repository needs nothing else: the clone runs anonymously.
A **private** repository needs shared credentials once on the host, in `~/.werkator.yml` of the service user, before cloning: A **private** repository needs shared credentials once on the host, in `~/.werkator.yml` of the service user, before cloning: