-:loudspeaker: The **[2022 NetBox community survey](https://forms.gle/KR8YbR8GiJ9EYXM28)** is now open! We collect this feedback and demographic data from NetBox users around the world to help shape the project's long-term development goals. Please take a few minutes to share your responses!
-
NetBox is an infrastructure resource modeling (IRM) tool designed to empower
diff --git a/base_requirements.txt b/base_requirements.txt
index 77a5bb8aa..4b814dbc7 100644
--- a/base_requirements.txt
+++ b/base_requirements.txt
@@ -68,7 +68,8 @@ gunicorn
# Platform-agnostic template rendering engine
# https://github.com/pallets/jinja
-Jinja2
+# Pin to v3.0 for mkdocstrings
+Jinja2<3.1
# Simple markup language for rendering HTML
# https://github.com/Python-Markdown/markdown
@@ -84,7 +85,7 @@ mkdocs-material
# Introspection for embedded code
# https://github.com/mkdocstrings/mkdocstrings
-mkdocstrings
+mkdocstrings<=0.17.0
# Library for manipulating IP prefixes and addresses
# https://github.com/netaddr/netaddr
diff --git a/docs/administration/authentication/microsoft-azure-ad.md b/docs/administration/authentication/microsoft-azure-ad.md
new file mode 100644
index 000000000..b2de148ac
--- /dev/null
+++ b/docs/administration/authentication/microsoft-azure-ad.md
@@ -0,0 +1,79 @@
+# Microsoft Azure AD
+
+This guide explains how to configure single sign-on (SSO) support for NetBox using [Microsoft Azure Active Directory (AD)](https://azure.microsoft.com/en-us/services/active-directory/) as an authentication backend.
+
+## Azure AD Configuration
+
+### 1. Create a test user (optional)
+
+Create a new user in AD to be used for testing. You can skip this step if you already have a suitable account created.
+
+### 2. Create an app registration
+
+Under the Azure Active Directory dashboard, navigate to **Add > App registration**.
+
+
+
+Enter a name for the registration (e.g. "NetBox") and ensure that the "single tenant" option is selected.
+
+Under "Redirect URI", select "Web" for the platform and enter the path to your NetBox installation, ending with `/oauth/complete/azuread-oauth2/`. Note that this URI **must** begin with `https://` unless you are referencing localhost (for development purposes).
+
+
+
+Once finished, make note of the application (client) ID; this will be used when configuring NetBox.
+
+
+
+!!! tip "Multitenant authentication"
+ NetBox also supports multitenant authentication via Azure AD, however it requires a different backend and an additional configuration parameter. Please see the [`python-social-auth` documentation](https://python-social-auth.readthedocs.io/en/latest/backends/azuread.html#tenant-support) for details concerning multitenant authentication.
+
+### 3. Create a secret
+
+When viewing the newly-created app registration, click the "Add a certificate or secret" link under "Client credentials". Under the "Client secrets" tab, click the "New client secret" button.
+
+
+
+You can optionally specify a description and select a lifetime for the secret.
+
+
+
+Once finished, make note of the secret value (not the secret ID); this will be used when configuring NetBox.
+
+
+
+## NetBox Configuration
+
+### 1. Enter configuration parameters
+
+Enter the following configuration parameters in `configuration.py`, substituting your own values:
+
+```python
+REMOTE_AUTH_BACKEND = 'social_core.backends.azuread.AzureADOAuth2'
+SOCIAL_AUTH_AZUREAD_OAUTH2_KEY = '{APPLICATION_ID}'
+SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET = '{SECRET_VALUE}'
+```
+
+### 2. Restart NetBox
+
+Restart the NetBox services so that the new configuration takes effect. This is typically done with the command below:
+
+```no-highlight
+sudo systemctl restart netbox
+```
+
+## Testing
+
+Log out of NetBox if already authenticated, and click the "Log In" button at top right. You should see the normal login form as well as an option to authenticate using Azure AD. Click that link.
+
+
+
+You should be redirected to Microsoft's authentication portal. Enter the username/email and password of your test account to continue. You may also be prompted to grant this application access to your account.
+
+
+
+If successful, you will be redirected back to the NetBox UI, and will be logged in as the AD user. You can verify this by navigating to your profile (using the button at top right).
+
+This user account has been replicated locally to NetBox, and can now be assigned groups and permissions within the NetBox admin UI.
+
+!!! note "Troubleshooting"
+ If you are redirected to the NetBox UI after authenticating, but are _not_ logged in, double-check the configured backend and app registration. The instructions in this guide pertain only to the `azuread.AzureADOAuth2` backend using a single-tenant app registration.
diff --git a/docs/administration/authentication/okta.md b/docs/administration/authentication/okta.md
new file mode 100644
index 000000000..ff552d730
--- /dev/null
+++ b/docs/administration/authentication/okta.md
@@ -0,0 +1,70 @@
+# Okta
+
+This guide explains how to configure single sign-on (SSO) support for NetBox using [Okta](https://www.okta.com/) as an authentication backend.
+
+## Okta Configuration
+
+!!! tip "Okta developer account"
+ Okta offers free developer accounts at | ASN | -{{ object.asn|placeholder }} | +ASN | +
+ {% if object.asn %}
+
+
+
+ {% endif %}
+ {{ object.asn|placeholder }}
+ |
+ |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ASNs | ++ {% for asn in object.asns.all %} + {{ asn|linkify }}{% if not forloop.last %}, {% endif %} + {% empty %} + {{ ''|placeholder }} + {% endfor %} + | |||||||||||||||||||||||||||||||||
| Account | diff --git a/netbox/templates/dcim/component_template_create.html b/netbox/templates/dcim/component_template_create.html index b3c5332b9..d164db872 100644 --- a/netbox/templates/dcim/component_template_create.html +++ b/netbox/templates/dcim/component_template_create.html @@ -2,33 +2,37 @@ {% load form_helpers %} {% block form %} -||||||||||||||||||||||||||||||||||
| Name | -Role | -Type | -Parent Device | -- {{ device }} - | -{{ device.device_role }} | -{{ device.device_type }} | - {% if device.parent_bay %} -{{ device.parent_bay.device|linkify }} | -{{ device.parent_bay }} | - {% else %} -— | +
|---|---|---|---|---|
| Name | +Role | +Type | +Parent Device | ++ {{ device }} + | +{{ device.device_role }} | +{{ device.device_type }} | + {% if device.parent_bay %} +{{ device.parent_bay.device|linkify }} | +{{ device.parent_bay }} | + {% else %} +— | + {% endif %} + + {% endfor %} +
|---|---|---|---|---|
| Module | +{{ module|linkify }} | +||
|---|---|---|---|
| Manufacturer | {{ module.module_type.manufacturer|linkify }} | @@ -60,6 +64,14 @@Module Type | {{ module.module_type|linkify }} |
| Serial Number | +{{ module.serial|placeholder }} | +||
| Asset Tag | +{{ module.asset_tag|placeholder }} | +
- A module import error occurred during this request. Common causes include the following: -
-
- Missing required packages - This installation of NetBox might be
- missing one or more required Python packages. These packages are listed in requirements.txt and
- local_requirements.txt, and are normally installed as part of the installation or upgrade process.
- To verify installed packages, run pip freeze from the console and compare the output to the list of
- required packages.
-
- WSGI service not restarted after upgrade - If this installation - has recently been upgraded, check that the WSGI service (e.g. gunicorn or uWSGI) has been restarted. This - ensures that the new code is running. -
++ A module import error occurred during this request. Common causes include the following: +
+
+ Missing required packages - This installation of NetBox might be
+ missing one or more required Python packages. These packages are listed in requirements.txt and
+ local_requirements.txt, and are normally installed as part of the installation or upgrade process. To
+ verify installed packages, run pip freeze from the console and compare the output to the list of
+ required packages.
+
+ WSGI service not restarted after upgrade - If this installation has + recently been upgraded, check that the WSGI service (e.g. gunicorn or uWSGI) has been restarted. This ensures that + the new code is running. +
{% endblock message %} diff --git a/netbox/templates/exceptions/permission_error.html b/netbox/templates/exceptions/permission_error.html index dcff62bf9..6108fde52 100644 --- a/netbox/templates/exceptions/permission_error.html +++ b/netbox/templates/exceptions/permission_error.html @@ -1,12 +1,12 @@ {% extends '500.html' %} {% block message %} -- A file permission error was detected while processing this request. Common causes include the following: -
-
- Insufficient write permission to the media root - The configured
- media root is {{ settings.MEDIA_ROOT }}. Ensure that the user NetBox runs as has access to write
- files to all locations within this path.
-
+ A file permission error was detected while processing this request. Common causes include the following: +
+
+ Insufficient write permission to the media root - The configured
+ media root is {{ settings.MEDIA_ROOT }}. Ensure that the user NetBox runs as has access to write files
+ to all locations within this path.
+
- A database programming error was detected while processing this request. Common causes include the following: -
-
- Database migrations missing - When upgrading to a new NetBox release, the upgrade script must
- be run to apply any new database migrations. You can run migrations manually by executing
- python3 manage.py migrate from the command line.
-
- Unsupported PostgreSQL version - Ensure that PostgreSQL version 9.6 or higher is in use. You
- can check this by connecting to the database using NetBox's credentials and issuing a query for
- SELECT VERSION().
-
+ A database programming error was detected while processing this request. Common causes include the following: +
+
+ Database migrations missing - When upgrading to a new NetBox release,
+ the upgrade script must be run to apply any new database migrations. You can run migrations manually by executing
+ python3 manage.py migrate from the command line.
+
+ Unsupported PostgreSQL version - Ensure that PostgreSQL version 10
+ or later is in use. You can check this by connecting to the database using NetBox's credentials and issuing a query
+ for SELECT VERSION().
+