From: Stephen Finucane <stephen@that.guru>
Date: Sat, 20 Feb 2021 15:12:53 +0000 (+0000)
Subject: docs: Note UTF-8 requirements for databases
X-Git-Tag: v3.1.0~100
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=576647e9e084d60b3c67dd56c47f1510a671f297;p=thirdparty%2Fpatchwork.git

docs: Note UTF-8 requirements for databases

MySQL 5.3 defaulted to 'latin1' encoding, meaning users would need to
explicitly configure their databases to use 'utf8'. Call this out.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #393
---

diff --git a/docs/deployment/installation.rst b/docs/deployment/installation.rst
index 6681002f..348af0ee 100644
--- a/docs/deployment/installation.rst
+++ b/docs/deployment/installation.rst
@@ -126,6 +126,17 @@ done later.
 
 __ https://www.postgresql.org/docs/10/static/auth-methods.html#AUTH-PEER
 
+.. note::
+
+    As noted in the `Django documentation`__, Django expects databases to be
+    configured with an encoding of UTF-8 or UTF-16. If using MySQL, you may
+    need to configure this this explicitly as older versions defaulted to
+    `latin1` encoding. Refer to the `MySQL documentation`__ for more
+    information.
+
+    __ https://docs.djangoproject.com/en/3.1/ref/unicode/
+    __ https://dev.mysql.com/doc/refman/en/charset.html
+
 
 Patchwork
 ---------