bootstrap-vz/bootstrapvz/plugins/apt_proxy/README.rst
John Kristensen 4120260a99 Add authentication support to the apt proxy plugin
Add username and password settings to the APT Proxy plugin so that
users who are behind an authenticating proxy can still use bootstrap-vz
without having to jump through hoops. If either the username or password
are not set, then no authentication is used.
2015-04-27 13:21:43 +10:00

27 lines
952 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``*