Changes between Version 7 and Version 8 of Nmm2022/Agenda/Netbox

Timestamp:

Jun 1, 2022, 4:35:09 PM (2 years ago)

Author:

geethike

Comment:

--

Nmm2022/Agenda/Netbox

@@ -138 +138 @@
 
 === DATABASE ===
-This parameter holds the database configuration details. You must define the username and password used when you configured PostgreSQL. If the service is running on a remote host, update the '''HOST and PORT ''' parameters accordingly. See the configuration documentation for more detail on individual parameters.
+This parameter holds the database configuration details. You must define the username and password used when you configured PostgreSQL. If the service is running on a remote host, update the '''HOST and PORT ''' parameters accordingly. 
 {{{
 DATABASE = {
@@ -150 +150 @@
 }}}
 
+=== 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. 
+
+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.
+{{{
+REDIS = {
+    'tasks': {
+        'HOST': 'localhost',      # Redis server
+        'PORT': 6379,             # Redis port
+        'PASSWORD': '',           # Redis password (optional)
+        'DATABASE': 0,            # Database ID
+        'SSL': False,             # Use SSL (optional)
+    },
+    'caching': {
+        'HOST': 'localhost',
+        'PORT': 6379,
+        'PASSWORD': '',
+        'DATABASE': 1,            # Unique ID for second database
+        'SSL': False,
+    }
+}
+}}}
+=== SECRET_KEY ===
+This parameter must be assigned a randomly-generated key employed as a salt for hashing and related cryptographic functions. (Note, however, that it is never directly used in the encryption of secret data.) This key must be unique to this installation and is recommended to be at least 50 characters long. It should not be shared outside the local system.
+
+A simple Python script named ''' generate_secret_key.py ''' is provided in the parent directory to assist in generating a suitable key:
+{{{
+# python3 ../generate_secret_key.py
+}}}
+When you have finished modifying the configuration, remember to save the file.
+
+=== Run the Upgrade Script ===
+Once NetBox has been configured, we're ready to proceed with the actual installation. We'll run the packaged upgrade script (upgrade.sh) to perform the following actions:
+
+* Create a Python virtual environment
+* Installs all required Python packages
+* Run database schema migrations
+* Builds the documentation locally (for offline use)
+* Aggregate static resource files on disk
+{{{
+# sudo /opt/netbox/upgrade.sh
+}}}