소스 검색

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
Tyler Bigler 6 년 전
부모
커밋
eaeb52de20
3개의 변경된 파일5개의 추가작업 그리고 1개의 파일을 삭제
  1. 3 1
      docs/configuration/required-settings.md
  2. 1 0
      docs/installation/2-netbox.md
  3. 1 0
      netbox/netbox/configuration.example.py

+ 3 - 1
docs/configuration/required-settings.md

@@ -21,6 +21,7 @@ NetBox requires access to a PostgreSQL database service to store data. This serv
 * `PASSWORD` - PostgreSQL password
 * `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)
+* `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:
 
@@ -31,6 +32,7 @@ DATABASE = {
     'PASSWORD': 'J5brHrAXFLQSif0K', # PostgreSQL password
     'HOST': 'localhost',            # Database server
     'PORT': '',                     # Database port (leave blank for default)
+    'CONN_MAX_AGE': 300,            # Max database connection age
 }
 ```
 
@@ -69,7 +71,7 @@ REDIS = {
 !!! note:
     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
-    `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:
     It is highly recommended to keep the webhook and cache databases seperate. Using the same database number for both may result in webhook

+ 1 - 0
docs/installation/2-netbox.md

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

+ 1 - 0
netbox/netbox/configuration.example.py

@@ -17,6 +17,7 @@ DATABASE = {
     'PASSWORD': '',           # PostgreSQL password
     'HOST': 'localhost',      # Database server
     '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.