diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 652d10afca..f302e000d3 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -159,10 +159,12 @@ Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce uni ## UPDATE_REPO_URL -Default: 'https://api.github.com/repos/netbox-community/netbox' +Default: None The releases of this repository are checked to detect new releases, which are shown on the home page of the web interface. You can change this to your own fork of the NetBox repository, or set it to `None` to disable the check. The URL provided **must** be compatible with the GitHub API. +Use `'https://api.github.com/repos/netbox-community/netbox'` to check for release in the official NetBox repository. + --- ## UPDATE_CACHE_TIMEOUT diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index a90d286e78..3c7de61282 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -125,8 +125,9 @@ EXEMPT_VIEW_PERMISSIONS = [ ] # This repository is used to check whether there is a new release of NetBox available. Set to None to disable the -# version check. -UPDATE_REPO_URL = 'https://api.github.com/repos/netbox-community/netbox' +# version check or use the URL below to check for release in the official NetBox repository. +UPDATE_REPO_URL = None +# UPDATE_REPO_URL = 'https://api.github.com/repos/netbox-community/netbox' # This determines how often the GitHub API is called to check the latest release of NetBox. Must be at least 1 hour. UPDATE_CACHE_TIMEOUT = 24 * 3600 diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index aaac8a1530..3578d67c43 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -80,8 +80,7 @@ DEVELOPER = getattr(configuration, 'DEVELOPER', False) EMAIL = getattr(configuration, 'EMAIL', {}) ENFORCE_GLOBAL_UNIQUE = getattr(configuration, 'ENFORCE_GLOBAL_UNIQUE', False) EXEMPT_VIEW_PERMISSIONS = getattr(configuration, 'EXEMPT_VIEW_PERMISSIONS', []) -UPDATE_REPO_URL = getattr(configuration, 'UPDATE_REPO_URL', - 'https://api.github.com/repos/netbox-community/netbox') +UPDATE_REPO_URL = getattr(configuration, 'UPDATE_REPO_URL', None) UPDATE_CACHE_TIMEOUT = getattr(configuration, 'UPDATE_CACHE_TIMEOUT', 24 * 3600) LOGGING = getattr(configuration, 'LOGGING', {}) LOGIN_REQUIRED = getattr(configuration, 'LOGIN_REQUIRED', False)