commit: 19c83b80daadff17d9a2e6b105daaca2a9316c2a
parent 9d7835e2341b4a0a3287d3d0762e4cbf4febff23
Author: fosslinux <fosslinux@aussies.space>
Date: Tue, 14 Jan 2025 19:51:17 +1100
Add a bit more docs for creating a mirror
Diffstat:
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/DEVEL.md b/DEVEL.md
@@ -110,5 +110,17 @@ snapshot, generated with `git archive`. See `mirror.sh` for more detailed rules.
Some specific helpful things:
- prefer `.tar.gz`
-- For GitHub, all snpashots are generated with long commit IDs, so use long
+- For GitHub, all snapshots are generated with long commit IDs, so use long
commit IDs.
+
+## Running a mirror
+
+There are 3 things you need to run a mirror;
+
+1. A tool to perform the mirroring (e.g. `mirror.sh` in this repository); we
+ encourage diversity in this area.
+2. A server on which to host the mirror; this should have HTTP support, and
+ optionally HTTPS. It is of greatly diminished utility if it does not support
+ plain HTTP.
+3. Automatic updates. This should involve updating the Git repository and
+ updating the mirror as required.