Skip to content

Commit c2d8f0d

Browse files
committed
Add a documentation warning about make postgres defaults #604
Signed-off-by: Thomas Druez <tdruez@nexb.com>
1 parent b79fe6a commit c2d8f0d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/installation.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,19 @@ production servers.
249249

250250
make postgresdb
251251

252+
.. warning::
253+
The ``make postgres`` command is assuming that your PostgreSQL database template is
254+
using the ``en_US.UTF-8`` collation.
255+
If you encounter database creation errors while running this command, it is
256+
generally related to an incompatible database template.
257+
258+
You can either `update your template <https://stackoverflow.com/a/60396581/8254946>`_
259+
to fit the ScanCode.io default, or provide custom values collation using the
260+
``POSTGRES_INITDB_ARGS`` variable such as::
261+
262+
make postgresdb POSTGRES_INITDB_ARGS=\
263+
--encoding=UTF-8 --lc-collate=en_US.UTF-8 --lc-ctype=en_US.UTF-8
264+
252265
.. note::
253266
You can also use a **SQLite** database for local development as a single user
254267
with::

0 commit comments

Comments
 (0)