comparison doc/upgrading.txt @ 5295:b2998cb86bae

Add new section: Errors and Troubleshooting - Full text searching not working Also make every Errors and Troubleshooting section header include description of problem.
author John Rouillard <rouilj@ieee.org>
date Thu, 28 Sep 2017 16:50:11 -0400
parents a034f8d09a21
children 6efa6d44c27a
comparison
equal deleted inserted replaced
5294:3e740c65510e 5295:b2998cb86bae
133 133
134 It is recommended that you change your templates so every form 134 It is recommended that you change your templates so every form
135 that is not submitted via GET has an @csrf field. Then change 135 that is not submitted via GET has an @csrf field. Then change
136 the csrf_enforce_token setting to 'required'. 136 the csrf_enforce_token setting to 'required'.
137 137
138 Errors and Troubleshooting 138 Errors and Troubleshooting - @csrf in url
139 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140 140
141 If you see the @csrf nonce in the URL, you have added the value to a 141 If you see the @csrf nonce in the URL, you have added the value to a
142 form that uses the GET method. You should remove the @csrf token from 142 form that uses the GET method. You should remove the @csrf token from
143 these forms as it is not needed. 143 these forms as it is not needed.
144 144
145 Errors and Troubleshooting - AttributeError list object no attribute value
146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145 If you get an error: 147 If you get an error:
146 148
147 AttributeError: 'list' object has no attribute 'value' 149 AttributeError: 'list' object has no attribute 'value'
148 150
149 in handle_csrf, you have more than one @csrf token for the form. This 151 in handle_csrf, you have more than one @csrf token for the form. This
220 # Force Roundup to use a particular text indexer. 222 # Force Roundup to use a particular text indexer.
221 # If no indexer is supplied, the first available indexer 223 # If no indexer is supplied, the first available indexer
222 # will be used in the following order: 224 # will be used in the following order:
223 # Possible values: xapian, whoosh, native (internal). 225 # Possible values: xapian, whoosh, native (internal).
224 indexer = 226 indexer =
227
228 Errors and Troubleshooting - Full text searching not working
229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
230
231 If after the upgrade full text searching is not working try changing
232 the indexer value. If this is failing most likely you need to set
233 '''indexer = native''' to use the rdbms or db text indexing systems.
234
235 Alternatively you can do a
236 '''roundup-admin -i /path/to/tracker reindex'''
237 to generate a new index using roundup's preferred indexer from the list above.
225 238
226 Stemming improved in Xapian Indexer 239 Stemming improved in Xapian Indexer
227 ----------------------------------- 240 -----------------------------------
228 241
229 Stemming allows a search for "silent" also match silently. The Porter 242 Stemming allows a search for "silent" also match silently. The Porter
304 <form method="post" tal:attributes="action string:${request/env/PATH_INFO}"> 317 <form method="post" tal:attributes="action string:${request/env/PATH_INFO}">
305 318
306 the important part is that the action field **must not** include any query 319 the important part is that the action field **must not** include any query
307 parameters ('#' includes query params). 320 parameters ('#' includes query params).
308 321
309 Errors and Troubleshooting 322 Errors and Troubleshooting - Unrecognized scheme in ...
310 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311 324
312 One symptom of failing to do this is getting an error: 325 One symptom of failing to do this is getting an error:
313 326
314 Unrecognized scheme in .... 327 Unrecognized scheme in ....
315 328
443 456
444 If you are running a tracker that **does not** allow read access for 457 If you are running a tracker that **does not** allow read access for
445 anonymous, you should remove this entry as it can be used to perform 458 anonymous, you should remove this entry as it can be used to perform
446 a username guessing attack against a roundup install. 459 a username guessing attack against a roundup install.
447 460
448 Errors and Troubleshooting 461 Errors and Troubleshooting - Unassigned issues for anonymous
449 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
450 463
451 If you notice that the "Unassigned Issues" search on page.html 464 If you notice that the "Unassigned Issues" search on page.html
452 is displaying assigned issues for users with the Anonymous role, 465 is displaying assigned issues for users with the Anonymous role,
453 you need to allow search permissions for the user class. 466 you need to allow search permissions for the user class.
454 467
524 s = db.security.addPermission(name='Search', klass='query', 537 s = db.security.addPermission(name='Search', klass='query',
525 properties=['creator'], 538 properties=['creator'],
526 description="User is allowed to Search queries for creator") 539 description="User is allowed to Search queries for creator")
527 db.security.addPermissionToRole('User', s) 540 db.security.addPermissionToRole('User', s)
528 541
529 Errors and Troubleshooting 542 Errors and Troubleshooting - Public queries listed twice when editing
530 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 543 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
531 544
532 If you do not do this, public queries will be listed twice in the edit 545 If you do not do this, public queries will be listed twice in the edit
533 interface. Once in the "Queries I created" section and again in the 546 interface. Once in the "Queries I created" section and again in the
534 "Queries others created" section of the query edit page 547 "Queries others created" section of the query edit page
535 (``http..../query?@template=edit``). 548 (``http..../query?@template=edit``).

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