summaryrefslogtreecommitdiffstats
path: root/dev/archive/mirroring.mdwn
blob: a951e2a69a69be8c7a06cce08765cfe7584161e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
[[!meta title="Mirroring the ProteanOS Package Archive"]]

Running a public mirror of the ProteanOS package archive contributes to the
availability of ProteanOS.

Organizations deploying many ProteanOS systems are encouraged to make local
mirrors, which they may keep private or make public, to save bandwidth on both
their and ProteanOS's infrastructure.


Setting up a Mirror
===================

A mirror takes about 730 MiB of storage space as of this writing and should be
expected to grow beyond that.

The curious may view a list of files in the archive with the following command:

    $ rsync --recursive --exclude .db rsync://files.proteanos.com/proteanos

See below for commands to copy archive files to a local mirror.

Packages are processed from the incoming queue into the archive four times
daily, so mirrors need not be updated more frequently than that.  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.

Serving the archive mirror at `/pub/proteanos` over HTTP and FTP is recommended,
but any path and either protocol may be used.

[arch-conf]: http://files.proteanos.com/pub/proteanos/conf

Primary Public Mirror
---------------------

Primary mirrors are those that synchronize directly from
<files.proteanos.com> and serve their contents publicly over rsync as well
as HTTP and/or FTP.

Run the following command one to four times daily to synchronize your mirror:

    $ rsync --recursive --times --delete --exclude .db \
    > rsync://files.proteanos.com/proteanos /path/to/your/mirror/directory/

Secondary Public or Private Mirror
----------------------------------

Secondary mirrors are those that synchronize from a primary mirror and serve
their contents either publicly or privately over HTTP and/or FTP.

Run the following command one to four times daily to synchronize your mirror:

    $ rsync --recursive --times --delete --exclude .db \
    > ${src} /path/to/your/mirror/directory/

Where `${src}` is any primary mirror listed in
<http://files.proteanos.com/pub/proteanos-mirrors-rsync>.


Announcing a Public Mirror
==========================

After setting up a public mirror, please announce it to the [ProteanOS
development mailing list][proteanos-dev] ([list info][proteanos-dev-info]).
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 (HTTP and/or FTP, and rsync for primary mirrors);
  * Country of site;
  * Frequency of mirroring; and
  * Any other comments about the site.

Your mirror will be reviewed and added to the official mirror lists
([HTTP][mirrors-http] and [FTP][mirrors-ftp] used by [[prokit]] and
[rsync][mirrors-rsync]) referenced above).

[proteanos-dev]: mailto:proteanos-dev@lists.proteanos.com
[proteanos-dev-info]: http://lists.proteanos.com/proteanos-dev/
[mirrors-http]: http://files.proteanos.com/pub/proteanos-mirrors-http
[mirrors-ftp]: http://files.proteanos.com/pub/proteanos-mirrors-ftp
[mirrors-rsync]: http://files.proteanos.com/pub/proteanos-mirrors-rsync