changeset 7698:4e37a7833708

doc: add FTS5 requirement for sqlite backend. Document the requirement for FTS5 if you are using the sqlite backend. Tonu Mikk reported issues with using a SQLite that was missing FTS5 support (RedHat 7 sqlite with python 3.6). Even though FTS5 has been in the sqlite amalgamation since 2015-10-14 (v3.9.0) RedHat chose to not build their package with that. This leads to a traceback when initializing the database.
author John Rouillard <rouilj@ieee.org>
date Sat, 11 Nov 2023 19:39:57 -0500
parents c73a1177c2b2
children e10d0b262abd
files doc/installation.txt
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/installation.txt	Wed Nov 08 21:18:34 2023 -0500
+++ b/doc/installation.txt	Sat Nov 11 19:39:57 2023 -0500
@@ -613,6 +613,15 @@
   Installed SQLite should be the latest version available (3.3.8 is known
   to work, 3.1.3 is known to have problems).
 
+  Installation of Roundup 2.2.0 or newer requires that the installed
+  SQLite supports FTS5. FTS5 was supported in release 3.9.0 in October
+  2015. However some vendors choose not to include it. You can check
+  your SQLite by using the command line::
+
+     echo 'pragma compile_options' | sqlite3 | grep FTS5
+
+  it should output ``ENABLE_FTS5`` if FTS5 is supported.
+
   Roundup supports using `SQLite's full text search capability
   <admin_guide.html#sqlite-details>`_. This
   can improve searching if you are not installing another indexer like

Roundup Issue Tracker: http://roundup-tracker.org/