Skip to content

Miscellaneous Parameters

ADMINS

Peering Manager will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example:

ADMINS = [
    ['Tony Stark', 'ironman@example.com'],
    ['Steve Rogers', 'captain@example.com'],
]

This defines custom content to be displayed on the login page above the login form. HTML is allowed.

CHANGELOG_RETENTION

Default: 90

The number of days to retain logged changes (object creations, updates, and deletions). Set this to 0 to retain changes in the database indefinitely.

Warning

If enabling indefinite changelog retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.

JOB_RETENTION

Note

This parameter was renamed from JOBRESULT_RETENTION in Peering Manager v1.8.

Default: 90

The number of days to retain job results. Set this to 0 to retain job results in the database indefinitely.

Warning

If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.

MAX_PAGE_SIZE

Default: 1000

A web user or API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. ?limit=1000). This parameter defines the maximum acceptable limit. Setting this to 0 or None will allow a client to retrieve all matching objects at once with no limit by specifying ?limit=0.

PAGINATE_COUNT

Default: 20

Determine how many objects to display per page within each list of objects.

METRICS_ENABLED

Default: False

Toggle the availability Prometheus-compatible metrics at /metrics. See the Prometheus Metrics documentation for more details.

RELEASE_CHECK_URL

Default: official Peering Manager URL

This parameter defines the URL of the repository that will be checked for new Peering Manager releases. When a new release is detected, a message will be displayed to administrative users on the home page. This can be set to the official repository ('https://api.github.com/repos/peering-manager/peering-manager/releases') or a custom fork. Set this to None to disable automatic update checks.

Note

The URL provided must be compatible with the GitHub REST API.

RQ_DEFAULT_TIMEOUT

Default: 300

The maximum execution time of a background task (such as running a PeeringDB synchronisation), in seconds.