Configuration Options¶
This is a list of all configuration parameters for pypicloud. In general, any of
these can be overridden by environment variables. To override a setting, create
an environment variable that is all uppercase, convert . to _, and
prefix with PPC_. For example: pypi.fallback = none becomes
PPC_PYPI_FALLBACK=none.
PyPICloud¶
pypi.fallback¶
Argument: {‘redirect’, ‘cache’, ‘none’}, optional
This option defines what the behavior is when a requested package is not found in the database. (default ‘redirect’)
redirect - Return a 302 to the package at the fallback_base_url.
cache - Download the package from fallback_base_url, store it in the
backend, and serve it. User must have cache_update permissions.
none - Return a 404
See also pypi.always_show_upstream below.
See Fallbacks for more detail on exactly how each fallback option will function.
pypi.always_show_upstream¶
Argument: bool, optional
Default False.
This adjusts the fallback behavior when one or more versions of the requested
package are stored in pypicloud. If False, pypicloud will only show the
client the versions that are stored. If True, the local versions will be
shown with the versions found at the fallback_base_url.
pypi.fallback_url¶
pypi.fallback_base_urlThe index server to handle the behavior defined in pypi.fallback (default
https://pypi.org/simple)
pypi.fallback_base_url¶
Argument: string, optional
This takes precendence over pypi.fallback by causing redirects to go to:
pypi.fallback_base_url/<simple|pypi>. (default https://pypi.org)
pypi.use_json_scraper¶
Argument: bool, optional
There are two methods pypicloud uses to fetch package data from the fallback
repo. The JSON scraper, and distlib.
Distlib has an issue where it does not return the “Requires-Python” metadata,
which can cause installation problems (see issue 219). If you are using a
non-standard fallback that supports the /json endpoints (e.g.
https://pypi.org/pypi/pypicloud/json), you may wish to set this to true so
that you get the proper “Requires-Python” metadata.
Will default to true if pypi.fallback_base_url is not set, or is set to https://pypi.org.
pypi.disallow_fallback¶
Argument: list, optional
List of packages that should not be fetch from pypi.fallback_base_url.
This is useful if private packages have the same name as a package in
pypi.fallback_base_url and you don’t want it to be replaced.
pypi.default_read¶
Argument: list, optional
List of groups that are allowed to read packages that have no explicit user or group permissions (default [‘authenticated’])
pypi.default_write¶
Argument: list, optional
List of groups that are allowed to write packages that have no explicit user or group permissions (default no groups, only admin users)
pypi.cache_update¶
Argument: list, optional
Only used when pypi.fallback = cache. This is
the list of groups that are allowed to trigger the operation that fetches
packages from fallback_base_url. (default [‘authenticated’])
pypi.calculate_package_hashes¶
Argument: bool, optional
Package SHA256 and MD5 hashes are now calculated by default when a package is uploaded. This option enables or disables the hash calculation (default true)
Scripts to calculate hashes on existing packages exist here: https://github.com/stevearc/pypicloud/tree/master/scripts
pypi.allow_overwrite¶
DEPRECATED see pypi.allow_overwrite_groups
Argument: bool, optional
Allow users to upload packages that will overwrite an existing version (default False)
pypi.allow_overwrite_groups¶
Argument: list, optional
List of groups that are allowed to overwrite existing packages. Defaults to no groups
pypi.allow_delete¶
DEPRECATED see pypi.allow_delete_groups
Argument: bool, optional
Allow users to delete packages (default True)
pypi.allow_delete_groups¶
Argument: list, optional
List of groups that are allowed to delete existing packages. Defaults to authenticated
pypi.realm¶
Argument: string, optional
The HTTP Basic Auth realm (default ‘pypi’)
pypi.download_url¶
Argument: string, optional
Overide for the root server URL displayed in the banner of the homepage.
pypi.stream_files¶
Argument: bool, optional
Whether or not to stream the raw package data from the storage database, as opposed to returning a redirect link to the storage database. This is useful for taking advantage of the local pip cache, which caches based on the URL returned. Note that this will in most scenarios make fetching a package slower, since the server will download the full package data before sending it to the client.
pypi.package_max_age¶
Argument: int, optional
The max-age parameter (in seconds) to use in the Cache-Control header when downloading packages. If not set, the default will be 0, which will tell pip not to cache any downloaded packages. In order to take advantage of the local pip cache, you should set this value to a relatively high number.
Storage¶
pypi.storage¶
Argument: string, optional
A dotted path to a subclass of IStorage. The
default is FileStorage. Each storage option may
have additional configuration options. Documentation for the built-in storage
backends can be found at Storage Backends.
Cache¶
pypi.db¶
Argument: string, optional
A dotted path to a subclass of ICache. The
default is SQLCache. Each cache option
may have additional configuration options. Documentation for the built-in
cache backends can be found at Caching Backends.
Access Control¶
pypi.auth¶
Argument: string, optional
A dotted path to a subclass of IAccessBackend. The
default is ConfigAccessBackend. Each backend option
may have additional configuration options. Documentation for the built-in
backends can be found at Access Control.
Beaker¶
Beaker is the session manager that handles user auth for the web interface. There are many configuration options, but these are the only ones you need to know about.
session.encrypt_key¶
Argument: string
Encryption key to use for the AES cipher. Here is a reasonable way to generate one:
$ python -c 'import os, base64; print(base64.b64encode(os.urandom(32)))'
session.validate_key¶
Argument: string
Validation key used to sign the AES encrypted data.
session.secure¶
Argument: bool, optional
If True, only set the session cookie for HTTPS connections (default False).
When running a production server, make sure this is always set to true.