diff --git a/docs/extra.css b/docs/extra.css index 1bdba5a13..6a95f356a 100644 --- a/docs/extra.css +++ b/docs/extra.css @@ -1,4 +1,11 @@ -/* Custom table styling */ +/* Images */ +img { + display: block; + margin-left: auto; + margin-right: auto; +} + +/* Tables */ table { margin-bottom: 24px; width: 100%; diff --git a/docs/installation/4-http-daemon.md b/docs/installation/4-http-daemon.md index 9124354cf..b93bdc3ef 100644 --- a/docs/installation/4-http-daemon.md +++ b/docs/installation/4-http-daemon.md @@ -72,7 +72,7 @@ Finally, ensure that the required Apache modules are enabled, enable the `netbox !!! note Certain components of NetBox (such as the display of rack elevation diagrams) rely on the use of embedded objects. Ensure that your HTTP server configuration does not override the `X-Frame-Options` response header set by NetBox. -## gunicorn Configuration +## Gunicorn Configuration Copy `/opt/netbox/contrib/gunicorn.py` to `/opt/netbox/gunicorn.py`. (We make a copy of this file to ensure that any changes to it do not get overwritten by a future upgrade.) @@ -81,7 +81,7 @@ Copy `/opt/netbox/contrib/gunicorn.py` to `/opt/netbox/gunicorn.py`. (We make a # cp contrib/gunicorn.py /opt/netbox/gunicorn.py ``` -You may wish to edit this file to change the bound IP address or port number, or to make performance-related adjustments. +You may wish to edit this file to change the bound IP address or port number, or to make performance-related adjustments. See [the Gunicorn documentation](https://docs.gunicorn.org/en/stable/configure.html) for the available configuration parameters. ## systemd Configuration @@ -101,7 +101,7 @@ Then, start the `netbox` and `netbox-rq` services and enable them to initiate at You can use the command `systemctl status netbox` to verify that the WSGI service is running: -``` +```no-highlight # systemctl status netbox.service ● netbox.service - NetBox WSGI Service Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled) diff --git a/docs/installation/index.md b/docs/installation/index.md index b3f63bcb6..4c904e953 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -8,6 +8,10 @@ The following sections detail how to set up a new instance of NetBox: 4. [HTTP daemon](4-http-daemon.md) 5. [LDAP authentication](5-ldap.md) (optional) +Below is a simplified overview of the NetBox application stack for reference: + +![NetBox UI as seen by a non-authenticated user](../media/installation/netbox_application_stack.png) + ## Upgrading If you are upgrading from an existing installation, please consult the [upgrading guide](upgrading.md). diff --git a/docs/media/installation/netbox_application_stack.png b/docs/media/installation/netbox_application_stack.png new file mode 100644 index 000000000..56de2070a Binary files /dev/null and b/docs/media/installation/netbox_application_stack.png differ