doc/proxy.texi

   1 @node Proxying
   2 @section Proxying
   3
   4 By default GoCheese is configured to use PyPI:
   5 @option{-pypi https://pypi.org/simple/},
   6 @option{-pypi-json https://pypi.org/pypi/} (if empty string, then do not
   7 try to update the metadata).
   8
   9 It gives several HTTP endpoints to work with:
  10
  11 @table @asis
  12
  13 @item @code{/simple/} (@option{-refresh} option)
  14 Simple API entrypoint. Each access to it asks for upstream if any state
  15 refresh is needed. Each refresh update the package's metadata (if
  16 @option{-pypi-json} is enabled), available releases and their checksums.
  17
  18 @item @code{/norefresh/} (@option{-norefresh} option)
  19 Same as above, but does not refresh data from the upstream, completely
  20 read only mode.
  21
  22 @item @code{/gpgupdate/} (@option{-gpgupdate} option)
  23 Refresh the package state from the upstream as above, but additionally
  24 check and download missing GPG signatures. Intended to be used only
  25 manually, for example after database migration.
  26 It is probably useful to set @env{$GOCHEESE_NO_SYNC=1} environment
  27 variable to turn off filesystem synchronization calls.
  28
  29 @item @code{/pypi/} (@option{-json} option)
  30 Read only (non refreshing) JSON API entrypoint, giving metadata for the
  31 packages and releases.
  32
  33 @item @code{/} and @code{/hr/*}
  34 Those URLs give human readable packages listing and package information.
  35
  36 @end table
  37
  38 To use GoCheese as a proxy, just configure your @file{pip.conf}:
  39
  40 @example
  41 [install]
  42 index-url = http://gocheese.host:8080/simple/
  43 @end example