debian/apt-p2p.conf.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!ENTITY dhfirstname "<firstname>Cameron</firstname>">
   5   <!ENTITY dhsurname   "<surname>Dale</surname>">
   6   <!-- Please adjust the date whenever revising the manpage. -->
   7   <!ENTITY dhdate      "<date>February 17, 2008</date>">
   8   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   9        allowed: see man(7), man(1). -->
  10   <!ENTITY dhsection   "<manvolnum>5</manvolnum>">
  11   <!ENTITY dhemail     "<email>camrdale@gmail.com</email>">
  12   <!ENTITY dhusername  "Cameron Dale">
  13   <!ENTITY dhucpackage "<refentrytitle>apt-p2p.conf</refentrytitle>">
  14   <!ENTITY dhpackage   "apt-p2p">
  15
  16   <!ENTITY debian      "<productname>Debian</productname>">
  17   <!ENTITY gnu         "<acronym>GNU</acronym>">
  18   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  19 ]>
  20
  21 <refentry>
  22   <refentryinfo>
  23     <address>
  24       &dhemail;
  25     </address>
  26     <author>
  27       &dhfirstname;
  28       &dhsurname;
  29     </author>
  30     <copyright>
  31       <year>2008</year>
  32       <holder>&dhusername;</holder>
  33     </copyright>
  34     &dhdate;
  35   </refentryinfo>
  36   <refmeta>
  37     &dhucpackage;
  38
  39     &dhsection;
  40   </refmeta>
  41
  42   <refnamediv>
  43     <refname>&dhpackage;</refname>
  44
  45     <refpurpose>configuration file for &dhpackage;</refpurpose>
  46   </refnamediv>
  47
  48   <refsect1>
  49     <title>DESCRIPTION</title>
  50
  51     <para>Configuration information for &dhpackage; is searched for in the following order, with later
  52       entries overriding former ones:
  53       <OrderedList>
  54         <ListItem><para>/etc/apt-p2p/apt-p2p.conf</para></ListItem>
  55         <ListItem><para>${HOME}/.apt-p2p/apt-p2p.conf</para></ListItem>
  56         <ListItem><para>the location specified by the config-file parameter</para></ListItem>
  57       </OrderedList>
  58     </para>
  59
  60   </refsect1>
  61   <refsect1>
  62     <title>FORMAT</title>
  63
  64     <para>&dhpackage; has a structure similar to Microsoft Windows INI files.
  65         The configuration file consists of sections, led by a ``[section]'' header and followed
  66         by ``name = value'' or ``name: value'' entries, with continuations in the style of RFC 822
  67         (values can span multiple lines by starting the subsequent lines with one or more spaces).
  68         Some values indicate times, in which case a suffix of 'd' for
  69         days, 'h' for hours, 'm' for minutes, and 's' for seconds can be used.
  70         Boolean values can be '1', 'yes', 'true', and 'on' to evaluate to True,
  71         or '0', 'no', 'false', and 'off' to evaluate to false.
  72         Note that leading whitespace is removed from values, and case is not important.
  73         Lines beginning with "#" or ";" are ignored and may be used to provide comments.</para>
  74
  75   </refsect1>
  76   <refsect1>
  77     <title>VARIABLES</title>
  78       <para>There are 2 required sections in the config file. The first is the DEFAULT section, providing
  79         variables for the configuration of the main application. The second is the section that provides
  80         variables for the configuration of the DHT.</para>
  81
  82       <refsect2>
  83         <title>DEFAULT</title>
  84
  85         <variablelist>
  86           <varlistentry>
  87             <term><option>PORT = <replaceable>number</replaceable></option></term>
  88              <listitem>
  89               <para>The <replaceable>number</replaceable> of the port to listen on for requests.
  90                   The main application will use this TCP port to listen for requests from APT, and
  91                   for uploads to other peers. If a port is not specified for the DHT, it will also
  92                   use this UDP port to listen for DHT requests.
  93                   (Default is 9977.)</para>
  94             </listitem>
  95           </varlistentry>
  96           <varlistentry>
  97             <term><option>UPLOAD_LIMIT = <replaceable>speed</replaceable></option></term>
  98              <listitem>
  99               <para>The <replaceable>speed</replaceable> to limit sending data to peers to, in KBytes/sec.
 100                 Set this to 0 to not limit the upload bandwidth.
 101                 (Default is 0)</para>
 102             </listitem>
 103           </varlistentry>
 104           <varlistentry>
 105             <term><option>MIN_DOWNLOAD_PEERS = <replaceable>number</replaceable></option></term>
 106              <listitem>
 107               <para>The minimum <replaceable>number</replaceable> of peers before the mirror is not used.
 108                 If there are fewer peers than this for a file, the mirror will also be
 109                 used to speed up the download. Set to 0 to never use the mirror if
 110                 there are peers.
 111                 (Default is 3)</para>
 112             </listitem>
 113           </varlistentry>
 114           <varlistentry>
 115             <term><option>CACHE_DIR = <replaceable>directory</replaceable></option></term>
 116              <listitem>
 117               <para>The <replaceable>directory</replaceable> to store the downloaded files in.
 118                 (Default is ${HOME}/.apt-p2p/cache.)</para>
 119             </listitem>
 120           </varlistentry>
 121           <varlistentry>
 122             <term><option>OTHER_DIRS = <replaceable>list</replaceable></option></term>
 123              <listitem>
 124               <para>The <replaceable>list</replaceable> of directories containing packages to share with others.
 125                 All files in these directories will be hashed and available for everybody to download.
 126                 (Default is to share only the files downloaded.)</para>
 127             </listitem>
 128           </varlistentry>
 129           <varlistentry>
 130             <term><option>LOCAL_OK = <replaceable>boolean</replaceable></option></term>
 131              <listitem>
 132               <para>Whether it's OK to use an IP addres from a known local or private range.
 133                 (Default is false)</para>
 134             </listitem>
 135           </varlistentry>
 136           <varlistentry>
 137             <term><option>REMOTE_STATS = <replaceable>boolean</replaceable></option></term>
 138              <listitem>
 139               <para>Whether a remote peer can access the statistics page.
 140                 (Default is True)</para>
 141             </listitem>
 142           </varlistentry>
 143           <varlistentry>
 144             <term><option>UNLOAD_PACKAGES_CACHE = <replaceable>time</replaceable></option></term>
 145              <listitem>
 146               <para>The <replaceable>time</replaceable> of inactivity to wait for before unloading the
 147                   packages cache. The packages cache uses a lot of memory, and only takes a few seconds
 148                   to reload when a new request arrives. (Default is 5 minutes.)</para>
 149             </listitem>
 150           </varlistentry>
 151           <varlistentry>
 152             <term><option>KEY_REFRESH = <replaceable>time</replaceable></option></term>
 153              <listitem>
 154               <para>The <replaceable>time</replaceable> after which to refresh DHT keys.
 155                   This should be a time slightly less than the DHT's KEY_EXPIRE value.
 156                   (Default is 57 minutes.)</para>
 157             </listitem>
 158           </varlistentry>
 159           <varlistentry>
 160             <term><option>DHT = <replaceable>string</replaceable></option></term>
 161              <listitem>
 162               <para>The DHT implementation to use. It must be possile to do (in python)
 163                 ``from &lt;DHT&gt;.DHT import DHT'' to get a class that implements the IDHT interface.
 164                 There should also be a similarly named section below to specify the options for the DHT.
 165                 (Default is `apt_p2p_Khashmir')</para>
 166             </listitem>
 167           </varlistentry>
 168           <varlistentry>
 169             <term><option>DHT-ONLY = <replaceable>boolean</replaceable></option></term>
 170              <listitem>
 171               <para>Whether to only run the DHT. This can be useful for providing only a bootstrap node.
 172                 (Default is false)</para>
 173             </listitem>
 174           </varlistentry>
 175         </variablelist>
 176       </refsect2>
 177       <refsect2>
 178         <title>apt_p2p_Khashmir</title>
 179
 180         <variablelist>
 181           <varlistentry>
 182             <term><option>PORT = <replaceable>number</replaceable></option></term>
 183              <listitem>
 184               <para>The <replaceable>number</replaceable> of the port to listen on for DHT (UDP) requests.
 185                   (Default is to use the value specified in the DEFAULT section.)</para>
 186             </listitem>
 187           </varlistentry>
 188           <varlistentry>
 189             <term><option>BOOTSTRAP = <replaceable>list</replaceable></option></term>
 190              <listitem>
 191               <para>The <replaceable>list</replaceable> of bootstrap nodes to contact to join the DHT.
 192                 Each node should be on a separate line, and start with the IP address or host name,
 193                 followed by a colon and the port number.
 194                 (Default is a list of known good nodes.)</para>
 195             </listitem>
 196           </varlistentry>
 197           <varlistentry>
 198             <term><option>BOOTSTRAP_NODE = <replaceable>boolean</replaceable></option></term>
 199              <listitem>
 200               <para>Whether this node is a bootstrap node.
 201                 (Default is false)</para>
 202             </listitem>
 203           </varlistentry>
 204           <varlistentry>
 205             <term><option>CHECKPOINT_INTERVAL = <replaceable>time</replaceable></option></term>
 206              <listitem>
 207               <para>The <replaceable>time</replaceable> to wait between saves of the running state.
 208                   (Default is 5 minutes.)</para>
 209             </listitem>
 210           </varlistentry>
 211           <varlistentry>
 212             <term><option>CONCURRENT_REQS = <replaceable>number</replaceable></option></term>
 213              <listitem>
 214               <para>The concurrent <replaceable>number</replaceable> of calls per find node/value request.
 215                   (Default is 4.)</para>
 216             </listitem>
 217           </varlistentry>
 218           <varlistentry>
 219             <term><option>STORE_REDUNDANCY = <replaceable>number</replaceable></option></term>
 220              <listitem>
 221               <para>The <replaceable>number</replaceable> of redundant copies of a value to store in the DHT.
 222                   (Default is 3.)</para>
 223             </listitem>
 224           </varlistentry>
 225           <varlistentry>
 226             <term><option>RETRIEVE_VALUES = <replaceable>number</replaceable></option></term>
 227              <listitem>
 228               <para>The <replaceable>number</replaceable> of values to attempt to retrieve from the DHT.
 229                   Setting this to 0 will try and get all values (which could take a while if
 230                   a lot of nodes have values). Setting it negative will try to get that
 231                   number of results from only the closest STORE_REDUNDANCY nodes to the hash.
 232                   (Default is -10000, which is a large negative number so all values from the closest
 233                   STORE_REDUNDANCY nodes will be retrieved.)</para>
 234             </listitem>
 235           </varlistentry>
 236           <varlistentry>
 237             <term><option>MAX_FAILURES = <replaceable>number</replaceable></option></term>
 238              <listitem>
 239               <para>The <replaceable>number</replaceable> of times in a row a node can fail to
 240                   respond before it's booted from the routing table.
 241                   (Default is 3.)</para>
 242             </listitem>
 243           </varlistentry>
 244           <varlistentry>
 245             <term><option>MIN_PING_INTERVAL = <replaceable>time</replaceable></option></term>
 246              <listitem>
 247               <para>The minimum <replaceable>time</replaceable> to wait before re-pinging a node.
 248                   (Default is 15 minutes.)</para>
 249             </listitem>
 250           </varlistentry>
 251           <varlistentry>
 252             <term><option>BUCKET_STALENESS = <replaceable>time</replaceable></option></term>
 253              <listitem>
 254               <para>The maximum <replaceable>time</replaceable> to wait before refreshing a bucket.
 255                   (Default is 1 hour.)</para>
 256             </listitem>
 257           </varlistentry>
 258           <varlistentry>
 259             <term><option>KEY_EXPIRE = <replaceable>time</replaceable></option></term>
 260              <listitem>
 261               <para>The <replaceable>time</replaceable> to wait before expiring unrefreshed keys.
 262                   (Default is 1 hour.)</para>
 263             </listitem>
 264           </varlistentry>
 265           <varlistentry>
 266             <term><option>SPEW = <replaceable>boolean</replaceable></option></term>
 267              <listitem>
 268               <para>Whether to log lots of info about the requests and responses in the protocol.
 269                 (Default is false)</para>
 270             </listitem>
 271           </varlistentry>
 272         </variablelist>
 273      </refsect2>
 274   </refsect1>
 275
 276   <refsect1>
 277     <title>SEE ALSO</title>
 278
 279     <para>
 280       <citerefentry><refentrytitle>apt-p2p</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 281     </para>
 282   </refsect1>
 283   <refsect1>
 284     <title>AUTHOR</title>
 285     <para>This manual page was written by &dhusername; &lt;&dhemail;> for
 286       the &debian; system (but may be used by others).  Permission is
 287       granted to copy, distribute and/or modify this document under
 288       the terms of the &gnu; General Public License, Version 2 or any
 289       later version published by the Free Software Foundation.
 290     </para>
 291     <para>
 292       On Debian systems, the complete text of the GNU General Public
 293       License can be found in /usr/share/common-licenses/GPL.
 294     </para>
 295   </refsect1>
 296 </refentry>
 297
 298 <!-- Keep this comment at the end of the file
 299 Local variables:
 300 mode: sgml
 301 sgml-omittag:t
 302 sgml-shorttag:t
 303 sgml-minimize-attributes:nil
 304 sgml-always-quote-attributes:t
 305 sgml-indent-step:2
 306 sgml-indent-data:t
 307 sgml-parent-document:nil
 308 sgml-default-dtd-file:nil
 309 sgml-exposed-tags:nil
 310 sgml-local-catalogs:nil
 311 sgml-local-ecat-files:nil
 312 End:
 313 -->