summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--dev/archive/mirroring.mdwn51
1 files changed, 51 insertions, 0 deletions
diff --git a/dev/archive/mirroring.mdwn b/dev/archive/mirroring.mdwn
new file mode 100644
index 0000000..ae2ef42
--- /dev/null
+++ b/dev/archive/mirroring.mdwn
@@ -0,0 +1,51 @@
+[[!meta title="Mirroring the ProteanOS Package Archive"]]
+
+Running a mirror of the ProteanOS package archive contributes to the
+availability of ProteanOS.
+
+You can keep your mirror private or make it an official mirror.
+
+
+Setting up a mirror
+===================
+
+A mirror is currently expected to take approximately 300 MiB of storage space.
+
+The following command will list files in the archive:
+
+ $ rsync --exclude .db rsync://files.proteanos.com/proteanos
+
+The following command will mirror the archive:
+
+ $ rsync --recursive --times --delete --exclude .db \
+ > rsync://files.proteanos.com/proteanos /path/to/your/mirror/directory/
+
+Packages are moved from incoming into the archive four times daily. The
+[[archive_management_software|dev/pro-archman]] is [configured][arch-conf] to
+keep unreferenced files in the pool for one day, so mirrors must be updated at
+least once a day. Otherwise, during the update, some feed index files may
+reference deleted files.
+
+[arch-conf]: http://files.proteanos.com/pub/proteanos/conf
+
+
+Making an official mirror
+=========================
+
+Official mirror sites should make their archive mirrors available at
+`/pub/proteanos` over HTTP and FTP. Sites should also make their archive
+mirrors accessible over rsync, if possible.
+
+Once your mirror is set up, please announce it to the [ProteanOS development
+mailing list][proteanos-dev]. Please include the following information in your
+announcement:
+
+ * Name and e-mail address of site maintainer;
+ * Name and URL of site sponsor, if any;
+ * Domain name, or IPv4 and/or IPv6 address, of mirror site;
+ * Available protocols;
+ * Country of site;
+ * Frequency of mirroring; and
+ * Any other comments about the site.
+
+[proteanos-dev]: mailto:proteanos-dev@lists.proteanos.com