changelog and docs updates for 2.6

docs/additional-features/caching.md

@@ -0,0 +1,21 @@
+# Caching
+
+To improve performance, NetBox supports caching for most object and list views. Caching is implemented using Redis,
+and [django-cacheops](https://github.com/Suor/django-cacheops)
+
+Several management commands are avaliable for administrators to manaully invalidate cache entries in extenuating circumstances.
+
+To invalidate a specifc model instance (for example a Device with ID 34):
+```
+python netbox/manage.py invalidate dcim.Device.34
+```
+
+To invalidate all instance of a model:
+```
+python netbox/manage.py invalidate dcim.Device
+```
+
+To flush the entire cache database:
+```
+python netbox/manage.py invalidate all
+```

docs/configuration/optional-settings.md

@@ -44,6 +44,14 @@ BASE_PATH = 'netbox/'
 
 ---
 
+## CACHE_TIMEOUT
+
+Default: 900
+
+The number of seconds to retain cache entries before automatically invalidating them.
+
+---
+
 ## CHANGELOG_RETENTION
 
 Default: 90
@@ -293,56 +301,3 @@ SHORT_TIME_FORMAT = 'H:i:s'          # 13:23:00
 DATETIME_FORMAT = 'N j, Y g:i a'     # June 26, 2016 1:23 p.m.
 SHORT_DATETIME_FORMAT = 'Y-m-d H:i'  # 2016-06-27 13:23
 ```
-
----
-
-## Redis Connection Settings
-
-[Redis](https://redis.io/) is a key-value store which functions as a very lightweight database. It is required when enabling NetBox [webhooks](../additional-features/webhooks/). A Redis connection is configured using a dictionary similar to the following:
-
-```
-REDIS = {
-    'HOST': 'localhost',
-    'PORT': 6379,
-    'PASSWORD': '',
-    'DATABASE': 0,
-    'DEFAULT_TIMEOUT': 300,
-    'SSL': False,
-}
-```
-
-### DATABASE
-
-Default: 0
-
-The Redis database ID.
-
-### DEFAULT_TIMEOUT
-
-Default: 300
-
-The timeout value to use when connecting to the Redis server (in seconds).
-
-### HOST
-
-Default: localhost
-
-The hostname or IP address of the Redis server.
-
-### PORT
-
-Default: 6379
-
-The TCP port to use when connecting to the Redis server.
-
-### PASSWORD
-
-Default: None
-
-The password to use when authenticating to the Redis server (optional).
-
-### SSL
-
-Default: False
-
-Use secure sockets layer to encrypt the connections to the Redis server.

docs/configuration/required-settings.md

@@ -43,3 +43,44 @@ This is a secret cryptographic key is used to improve the security of cookies an
 Please note that this key is **not** used for hashing user passwords or for the encrypted storage of secret data in NetBox.
 
 `SECRET_KEY` should be at least 50 characters in length and contain a random mix of letters, digits, and symbols. The script located at `netbox/generate_secret_key.py` may be used to generate a suitable key.
+
+---
+
+## REDIS
+
+[Redis](https://redis.io/) is an in-memory data store similar to memcached. While Redis has been an optional component of
+NetBox since the introduction of webhooks in version 2.4, it is required starting in 2.6 to support NetBox's caching
+functionality (as well as other planned features).
+
+Redis is configured using a configuration setting similar to `DATABASE`:
+
+* HOST - Name or IP address of the Redis server (use `localhost` if running locally)
+* PORT - TCP port of the Redis service; leave blank for default port (6379)
+* PASSWORD - Redis password (if set)
+* DATABASE - Numeric database ID for webhooks
+* CACHE_DATABASE - Numeric database ID for caching
+* DEFAULT_TIMEOUT - Connection timeout in seconds
+* SSL - Use SSL connection to Redis
+
+Example:
+
+```
+REDIS = {
+    'HOST': 'localhost',
+    'PORT': 6379,
+    'PASSWORD': '',
+    'DATABASE': 0,
+    'CACHE_DATABASE': 1,
+    'DEFAULT_TIMEOUT': 300,
+    'SSL': False,
+}
+```
+
+!!! 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. 
+
+!!! warning:
+    It is highly recommended to keep the webhook and cache databases seperate. Using the same database number for both may result in webhook
+    processing data being lost in cache flushing events.

docs/development/release-checklist.md

@@ -29,6 +29,7 @@ Update the following static libraries to their most recent stable release:
 
 * Bootstrap 3
 * Font Awesome 4
+* Select2
 * jQuery
 * jQuery UI