Add CONN_MAX_AGE to documentation (#3642)

* Add CONN_MAX_AGE to sample configurations

* Correct alignment

* Restore ghost space

* Correct alignment.

* Use stable docs url
This commit is contained in:
Tyler Bigler 2019-10-25 13:11:48 -04:00 committed by Jeremy Stretch
parent fdbf41e9fd
commit eaeb52de20
3 changed files with 5 additions and 1 deletions

View File

@ -21,6 +21,7 @@ NetBox requires access to a PostgreSQL database service to store data. This serv
* `PASSWORD` - PostgreSQL password * `PASSWORD` - PostgreSQL password
* `HOST` - Name or IP address of the database server (use `localhost` if running locally) * `HOST` - Name or IP address of the database server (use `localhost` if running locally)
* `PORT` - TCP port of the PostgreSQL service; leave blank for default port (5432) * `PORT` - TCP port of the PostgreSQL service; leave blank for default port (5432)
* `CONN_MAX_AGE` - Number in seconds for Netbox to keep database connections open. 150-300 seconds is typically a good starting point ([more info](https://docs.djangoproject.com/en/stable/ref/databases/#persistent-connections)).
Example: Example:
@ -31,6 +32,7 @@ DATABASE = {
'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password 'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
'HOST': 'localhost', # Database server 'HOST': 'localhost', # Database server
'PORT': '', # Database port (leave blank for default) 'PORT': '', # Database port (leave blank for default)
'CONN_MAX_AGE': 300, # Max database connection age
} }
``` ```
@ -69,7 +71,7 @@ REDIS = {
!!! note: !!! note:
If you were using these settings in a prior release with webhooks, the `DATABASE` setting remains the same but If you were using these settings in a prior release with webhooks, the `DATABASE` setting remains the same but
an additional `CACHE_DATABASE` setting has been added with a default value of 1 to support the caching backend. The an additional `CACHE_DATABASE` setting has been added with a default value of 1 to support the caching backend. The
`DATABASE` setting will be renamed in a future release of NetBox to better relay the meaning of the setting. `DATABASE` setting will be renamed in a future release of NetBox to better relay the meaning of the setting.
!!! warning: !!! warning:
It is highly recommended to keep the webhook and cache databases seperate. Using the same database number for both may result in webhook It is highly recommended to keep the webhook and cache databases seperate. Using the same database number for both may result in webhook

View File

@ -129,6 +129,7 @@ DATABASE = {
'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password 'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
'HOST': 'localhost', # Database server 'HOST': 'localhost', # Database server
'PORT': '', # Database port (leave blank for default) 'PORT': '', # Database port (leave blank for default)
'CONN_MAX_AGE': 300, # Max database connection age
} }
``` ```

View File

@ -17,6 +17,7 @@ DATABASE = {
'PASSWORD': '', # PostgreSQL password 'PASSWORD': '', # PostgreSQL password
'HOST': 'localhost', # Database server 'HOST': 'localhost', # Database server
'PORT': '', # Database port (leave blank for default) 'PORT': '', # Database port (leave blank for default)
'CONN_MAX_AGE': 300, # Max database connection age
} }
# This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file. # This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file.