[[!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 following command will list files in the archive:

    $ rsync --recursive --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 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.

[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] ([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;
  * Country of site;
  * Frequency of mirroring; and
  * Any other comments about the site.

[proteanos-dev]: mailto:proteanos-dev@lists.proteanos.com
[proteanos-dev-info]: http://lists.proteanos.com/proteanos-dev/