|
@@ -36,7 +36,7 @@ sudo ln -s /opt/netbox-X.Y.Z/ /opt/netbox
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
!!! note
|
|
!!! note
|
|
|
- It is recommended to install NetBox in a directory named for its version number. For example, NetBox v3.0.0 would be installed into `/opt/netbox-3.0.0`, and a symlink from `/opt/netbox/` would point to this location. (You can verify this configuration with the command `ls -l /opt | grep netbox`.) This allows for future releases to be installed in parallel without interrupting the current installation. When changing to the new release, only the symlink needs to be updated.
|
|
|
|
|
|
|
+ It is recommended to install NetBox in a directory named for its version number. For example, NetBox v4.0.0 would be installed into `/opt/netbox-4.0.0`, and a symlink from `/opt/netbox/` would point to this location. (You can verify this configuration with the command `ls -l /opt | grep netbox`.) This allows for future releases to be installed in parallel without interrupting the current installation. When changing to the new release, only the symlink needs to be updated.
|
|
|
|
|
|
|
|
### Option B: Clone the Git Repository
|
|
### Option B: Clone the Git Repository
|
|
|
|
|
|
|
@@ -63,12 +63,12 @@ This command should generate output similar to the following:
|
|
|
|
|
|
|
|
```
|
|
```
|
|
|
Cloning into '.'...
|
|
Cloning into '.'...
|
|
|
-remote: Enumerating objects: 996, done.
|
|
|
|
|
-remote: Counting objects: 100% (996/996), done.
|
|
|
|
|
-remote: Compressing objects: 100% (935/935), done.
|
|
|
|
|
-remote: Total 996 (delta 148), reused 386 (delta 34), pack-reused 0
|
|
|
|
|
-Receiving objects: 100% (996/996), 4.26 MiB | 9.81 MiB/s, done.
|
|
|
|
|
-Resolving deltas: 100% (148/148), done.
|
|
|
|
|
|
|
+remote: Enumerating objects: 148317, done.
|
|
|
|
|
+remote: Counting objects: 100% (183/183), done.
|
|
|
|
|
+remote: Compressing objects: 100% (115/115), done.
|
|
|
|
|
+remote: Total 148317 (delta 127), reused 68 (delta 68), pack-reused 148134 (from 3)
|
|
|
|
|
+Receiving objects: 100% (148317/148317), 165.12 MiB | 28.71 MiB/s, done.
|
|
|
|
|
+Resolving deltas: 100% (116428/116428), done.
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Finally, check out the tag for the desired release. You can find these on our [releases page](https://github.com/netbox-community/netbox/releases). Replace `vX.Y.Z` with your selected release tag below.
|
|
Finally, check out the tag for the desired release. You can find these on our [releases page](https://github.com/netbox-community/netbox/releases). Replace `vX.Y.Z` with your selected release tag below.
|
|
@@ -102,7 +102,8 @@ sudo cp configuration_example.py configuration.py
|
|
|
Open `configuration.py` with your preferred editor to begin configuring NetBox. NetBox offers [many configuration parameters](../configuration/index.md), but only the following four are required for new installations:
|
|
Open `configuration.py` with your preferred editor to begin configuring NetBox. NetBox offers [many configuration parameters](../configuration/index.md), but only the following four are required for new installations:
|
|
|
|
|
|
|
|
* `ALLOWED_HOSTS`
|
|
* `ALLOWED_HOSTS`
|
|
|
-* `DATABASES` (or `DATABASE`)
|
|
|
|
|
|
|
+* `API_TOKEN_PEPPERS`
|
|
|
|
|
+* `DATABASES`
|
|
|
* `REDIS`
|
|
* `REDIS`
|
|
|
* `SECRET_KEY`
|
|
* `SECRET_KEY`
|
|
|
|
|
|
|
@@ -158,7 +159,7 @@ DATABASES = {
|
|
|
|
|
|
|
|
### REDIS
|
|
### REDIS
|
|
|
|
|
|
|
|
-Redis is a in-memory key-value store used by NetBox for caching and background task queuing. Redis typically requires minimal configuration; the values below should suffice for most installations. See the [configuration documentation](../configuration/required-parameters.md#redis) for more detail on individual parameters.
|
|
|
|
|
|
|
+Redis is an in-memory key-value store used by NetBox for caching and background task queuing. Redis typically requires minimal configuration; the values below should suffice for most installations. See the [configuration documentation](../configuration/required-parameters.md#redis) for more detail on individual parameters.
|
|
|
|
|
|
|
|
Note that NetBox requires the specification of two separate Redis databases: `tasks` and `caching`. These may both be provided by the same Redis service, however each should have a unique numeric database ID.
|
|
Note that NetBox requires the specification of two separate Redis databases: `tasks` and `caching`. These may both be provided by the same Redis service, however each should have a unique numeric database ID.
|
|
|
|
|
|
|
@@ -252,7 +253,7 @@ Once NetBox has been configured, we're ready to proceed with the actual installa
|
|
|
sudo /opt/netbox/upgrade.sh
|
|
sudo /opt/netbox/upgrade.sh
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-Note that **Python 3.12 or later is required** for NetBox v4.5 and later releases. If the default Python installation on your server is set to a lesser version, pass the path to the supported installation as an environment variable named `PYTHON`. (Note that the environment variable must be passed _after_ the `sudo` command.)
|
|
|
|
|
|
|
+Note that **Python 3.12 or later is required** for NetBox v4.5 and later releases. If the default Python installation on your server is set to a lesser version, pass the path to the supported installation as an environment variable named `PYTHON`. (Note that the environment variable must be passed _after_ the `sudo` command.)
|
|
|
|
|
|
|
|
```no-highlight
|
|
```no-highlight
|
|
|
sudo PYTHON=/usr/bin/python3.12 /opt/netbox/upgrade.sh
|
|
sudo PYTHON=/usr/bin/python3.12 /opt/netbox/upgrade.sh
|
|
@@ -295,13 +296,12 @@ python3 manage.py runserver 0.0.0.0:8000 --insecure
|
|
|
If successful, you should see output similar to the following:
|
|
If successful, you should see output similar to the following:
|
|
|
|
|
|
|
|
```no-highlight
|
|
```no-highlight
|
|
|
-Watching for file changes with StatReloader
|
|
|
|
|
Performing system checks...
|
|
Performing system checks...
|
|
|
|
|
|
|
|
System check identified no issues (0 silenced).
|
|
System check identified no issues (0 silenced).
|
|
|
-August 30, 2021 - 18:02:23
|
|
|
|
|
-Django version 3.2.6, using settings 'netbox.settings'
|
|
|
|
|
-Starting development server at http://127.0.0.1:8000/
|
|
|
|
|
|
|
+January 26, 2026 - 17:00:00
|
|
|
|
|
+Django version 5.2.10, using settings 'netbox.settings'
|
|
|
|
|
+Starting development server at http://0.0.0.0:8000/
|
|
|
Quit the server with CONTROL-C.
|
|
Quit the server with CONTROL-C.
|
|
|
```
|
|
```
|
|
|
|
|
|