Skip to content

Clarify that cache is not strictly necessary #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 19, 2021
Merged

Clarify that cache is not strictly necessary #16

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3493fb3
Clarify that cache is not strictly necessary
abeforgit Oct 27, 2020
8ee8e28
Apply suggestions
abeforgit Nov 12, 2020
549a9d8
Merge branch 'master' into patch-1
abeforgit Apr 18, 2021
c1ae5a3
Correct and clarify cache requirements
abeforgit Apr 18, 2021
5b4bfc9
Clarify cache setup documentation
abeforgit Apr 18, 2021
d7da050
Distinguish between single-server and multi-server setups
abeforgit Apr 18, 2021
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,21 @@ Add ``django_select`` to your URL root configuration:
# … other patterns
]

Finally make sure you have a persistent cache backend setup (NOT
:class:`.DummyCache` or :class:`.LocMemCache`), we will use Redis in this
example. Make sure you have a Redis server up and running::

``django-select2`` requires a cache backend which is **persistent**
across all application servers..

**This means that the** :class:`.DummyCache` **backend will not work!**

The default cache backend is :class:`.LocMemCache`, which is persistent
across a single node. For projects with a single application server
this will work fine, however you will run into issues when
you scale up into multiple servers.

Below is an example setup using Redis, which is a solution that
works for multi-server setups:

Make sure you have a Redis server up and running::

# Debian
sudo apt-get install redis-server
Expand Down