Mercurial > p > roundup > code

comparison doc/upgrading.txt @ 6591:feab8c878d08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix code formatting, add link for Configuring Compression.
author John Rouillard <rouilj@ieee.org>
date Mon, 24 Jan 2022 21:29:44 -0500
parents 39308a49fdc3
children 39189dd94f2c
comparison
equal deleted inserted replaced
6590:39308a49fdc3 6591:feab8c878d08
53 another interface to the tracker, or are using anydbm). 53 another interface to the tracker, or are using anydbm).
54 54
55 Check compression settings (optional) 55 Check compression settings (optional)
56 ------------------------------------- 56 -------------------------------------
57 57
58 Read the `administration guide`_ section on 'Configuring Compression'. 58 Read the `administration guide`_ section on `Configuring Compression`_.
59 59
60 Upgrade tracker's config.ini file. Use:: 60 Upgrade tracker's config.ini file. Use::
61 61
62 roundup-admin -i /path/to/tracker updateconfig newconfig.ini 62 roundup-admin -i /path/to/tracker updateconfig newconfig.ini
63 63
91 out common works (i.e. there is no stoplist). So words like "and", 91 out common works (i.e. there is no stoplist). So words like "and",
92 "or", "then", "with" ... are included in the FTS5 search. The native 92 "or", "then", "with" ... are included in the FTS5 search. The native
93 search applies both filters. 93 search applies both filters.
94 94
95 Using SQLite FTS requires a schema change so you should run 95 Using SQLite FTS requires a schema change so you should run
96 `roundup-admin -i tracker_home migrate` as the FTS specific tables 96 ``roundup-admin -i tracker_home migrate`` as the FTS specific tables
97 need to be created. 97 need to be created.
98 98
99 Then you must explicitly enable it by changing the `indexer` setting 99 Then you must explicitly enable it by changing the ``indexer`` setting
100 in `config.ini` to `native-fts`. Native-fts is never chosen by default 100 in ``config.ini`` to ``native-fts``. Native-fts is never chosen by default
101 like xapian or whoosh. This prevents the existing native indexing from 101 like xapian or whoosh. This prevents the existing native indexing from
102 being discarded if `indexer` is not set. 102 being discarded if ``indexer`` is not set.
103 103
104 Next re-index your data with `roundup-admin -i tracker_home 104 Next re-index your data with ``roundup-admin -i tracker_home
105 reindex`. This can take a while depending on the size of the tracker. 105 reindex``. This can take a while depending on the size of the tracker.
106 106
107 You may want to update your `config.ini` by following the directions 107 You may want to update your ``config.ini`` by following the directions
108 above to get the latest documentation. 108 above to get the latest documentation.
109 109
110 If you are happy with the fts indexing, you can save some space by 110 If you are happy with the fts indexing, you can save some space by
111 removing the data from the native text indexing tables. This requires 111 removing the data from the native text indexing tables. This requires
112 using the `sqlite3` command to delete the rows in the `__textids` and 112 using the ``sqlite3`` command to delete the rows in the ``__textids`` and
113 `__words` tables. You can do this with the following sqlite3 113 ``__words`` tables. You can do this with the following sqlite3
114 commands:: 114 commands::
115 115
116 delete from __words; 116 delete from __words;
117 delete from __textids; 117 delete from __textids;
118 118
122 Currently some internal errors result in a bare html page with an 122 Currently some internal errors result in a bare html page with an
123 error message. The usual chrome supplied by page.html is not shown. 123 error message. The usual chrome supplied by page.html is not shown.
124 For example query language syntax errors for full text search methods 124 For example query language syntax errors for full text search methods
125 will display a bare HTML error page. 125 will display a bare HTML error page.
126 126
127 If you add an `_generic.400.html` template to the html directory, you 127 If you add an ``_generic.400.html`` template to the html directory, you
128 can display the error inside of the layout provided by the `page.html` 128 can display the error inside of the layout provided by the ``page.html``
129 template. This can make fixing the error and navigation easier. You 129 template. This can make fixing the error and navigation easier. You
130 can use the `_generic.404.html` template to create a 130 can use the ``_generic.404.html`` template to create a
131 `_generic.400.html` by modifying the title and body text. You can test 131 ``_generic.400.html`` by modifying the title and body text. You can test
132 the 400 template by appending `@template=400` to the url for the 132 the 400 template by appending ``@template=400`` to the url for the
133 tracker. 133 tracker.
134 134
135 Migrating from 2.0.0 to 2.1.0 135 Migrating from 2.0.0 to 2.1.0
136 ============================= 136 =============================
137 137
3343 .. _`customisation documentation`: customizing.html 3343 .. _`customisation documentation`: customizing.html
3344 .. _`security documentation`: security.html 3344 .. _`security documentation`: security.html
3345 .. _`administration guide`: admin_guide.html 3345 .. _`administration guide`: admin_guide.html
3346 .. _`xmlrpc guide`: xmlrpc.html 3346 .. _`xmlrpc guide`: xmlrpc.html
3347 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html 3347 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html
3348 .. _Configuring Compression: admin_guide.html#configuring-compression
Roundup Issue Tracker: http://roundup-tracker.org/