From: W. Trevor King <wking@tremily.us>
Date: Fri, 21 Feb 2014 05:41:42 +0000 (-0800)
Subject: README: Document Gentoo / OpenRC usage for distfiles caching
X-Git-Tag: v0.1~1
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=8982de05112d3834651b0d56051433c5691ca8b0;p=package-cache.git

README: Document Gentoo / OpenRC usage for distfiles caching

This is what I'm using this project for ;).
---

diff --git a/README b/README
index 687647b..1a8f3fa 100644
--- a/README
+++ b/README
@@ -34,6 +34,31 @@ For other command-line options, see::
 
 If you need a more perfomant backend, you might try Gunicorn_.
 
+Gentoo
+======
+
+There's an OpenRC_ init script in ``contrib/openrc/init.d``, and a
+package-cache ebuild in my `wtk overlay`_.  To use package-cache as a
+caching proxy for your distfiles downloads, add the ``wtk`` overlay to
+layman_ and run::
+
+  # emerge --ask --verbose net-proxy/package-cache
+  # rc-update add default net-proxy/package-cache
+  # rc-service package-cache start
+
+You can tweak the parameters by setting variables in
+``/etc/conf.d/package-cache`` (``PC_USER``, ``PC_GROUP``,
+``CACHE_DIR``, ``HOST``, ``PORT``, ``SOURCES``, and ``PC_OPTS``).  See
+the init script for default values.
+
+Once you've setup your package-cache service, just point your local
+package manager to the cache server instead of the usual mirror.  For
+Portage_, that's going to be something like:
+
+  GENTOO_MIRRORS="http://my-package-cache-server.net:4000/"
+
+in your ``/etc/portage/make.conf``.
+
 .. _Gentoo's distfiles:
   https://wiki.gentoo.org/wiki/Project:Infrastructure/Source_mirrors
 .. _Cache-Control headers:
@@ -42,3 +67,7 @@ If you need a more perfomant backend, you might try Gunicorn_.
   http://docs.python.org/3/library/wsgiref.html
 .. _Gunicorn:
   http://gunicorn-docs.readthedocs.org/en/latest/run.html#gunicorn
+.. _OpenRC: http://www.gentoo.org/proj/en/base/openrc/
+.. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
+.. _layman: https://wiki.gentoo.org/wiki/Layman
+.. _Portage: http://wiki.gentoo.org/wiki/Project:Portage