bootstrap-vz/bootstrapvz/plugins/apt_proxy/README.rst
Tiago Ilieve b3cda5e859 Docs: fix apt_proxy plugin's README
`address` and `port` description were being rendered as bold because of
an extra space indenting its `required` note.

Also escaped `true`/`false` terms for the `persistent` option.
2015-04-28 01:32:51 -03:00

27 lines
949 B
ReStructuredText

APT Proxy
---------
This plugin creates a proxy configuration file for APT, so you could
enjoy the benefits of using cached packages instead of downloading them
from the mirror every time. You could just install ``apt-cacher-ng`` on
the host machine and then add ``"address": "127.0.0.1"`` and
``"port": 3142`` to the manifest file.
Settings
~~~~~~~~
- ``address``: The IP or host of the proxy server.
``required``
- ``port``: The port (integer) of the proxy server.
``required``
- ``username``: The username for authentication against the proxy server.
This is ignored if ``password`` is not also set.
``optional``
- ``password``: The password for authentication against the proxy server.
This is ignored if ``username`` is not also set.
``optional``
- ``persistent``: Whether the proxy configuration file should remain on
the machine or not.
Valid values: ``true``, ``false``
Default: ``false``.
``optional``