Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 7961:32ead43b8299
docs: postgres user; wsgi default mode update; diff for task.index.html
Update docs for creating postgresql roundup user for database and
schema cases.
Reword wsgi performance improvement disabling doc and add request for
email if it needs to be disabled.
Add link to diff for changes to task.index.html.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 13 May 2024 13:32:02 -0400 |
| parents | 88239d4ac4ab |
| children | 791b61ed11c9 |
comparison
equal
deleted
inserted
replaced
| 7960:1505f6ab86ec | 7961:32ead43b8299 |
|---|---|
| 235 .. _issue2551115: https://issues.roundup-tracker.org/issue2551115 | 235 .. _issue2551115: https://issues.roundup-tracker.org/issue2551115 |
| 236 | 236 |
| 237 Disable performance improvement for wsgi mode (optional) | 237 Disable performance improvement for wsgi mode (optional) |
| 238 -------------------------------------------------------- | 238 -------------------------------------------------------- |
| 239 | 239 |
| 240 In Roundup version 2.2.0 an experimental option to improve performance | 240 In Roundup version 2.2.0, an experimental feature was introduced to |
| 241 when running in wsgi mode was added. It as disabled at that time. In | 241 enhance performance while operating in wsgi mode. Initially, this |
| 242 the last two years it has been in use at a few sits with no reports of | 242 feature was disabled. Over the past two years, it has been used at a |
| 243 issues. | 243 few sites without any reported problems. |
| 244 | 244 |
| 245 So the default mode is now to enable this improvement. This will get | 245 As a result, the default setting now enables this performance |
| 246 more people using it. In case there is a latent bug that hasn't been | 246 improvement, encouraging a wider adoption of the feature. In the |
| 247 discovered, it can still be disabled. To disable it, add the | 247 event that an undiscovered bug arises, it can still be disabled |
| 248 feature_flags to the RequestDispatcher as below: | 248 if you experience problems. To disable it, modify your wsgi |
| 249 startup script and add the feature_flags to the RequestDispatcher | |
| 250 as below: | |
| 249 | 251 |
| 250 feature_flags = { "cache_tracker": False } | 252 feature_flags = { "cache_tracker": False } |
| 251 app = RequestDispatcher(tracker_home, feature_flags=feature_flags) | 253 app = RequestDispatcher(tracker_home, feature_flags=feature_flags) |
| 252 | 254 |
| 253 and restart your wsgi instance. | 255 Then restart your wsgi instance. If you have to disable this |
| 256 feature, send email to the roundup-users mailing list | |
| 257 (roundup-users at lists.sourceforge.net) so we can help you | |
| 258 diagnose the cause and fix it for everybody. | |
| 259 | |
| 260 In the future, support for disabling this improvement will be removed. | |
| 254 | 261 |
| 255 Fix duplicate id for confirm password in user.item.html (optional) | 262 Fix duplicate id for confirm password in user.item.html (optional) |
| 256 ------------------------------------------------------------------ | 263 ------------------------------------------------------------------ |
| 257 | 264 |
| 258 The TAL macro ``user_confirm_input`` at the end of ``html/page.html`` | 265 The TAL macro ``user_confirm_input`` at the end of ``html/page.html`` |
| 291 The removed columns are: severity, versions, keywords, dependencies. | 298 The removed columns are: severity, versions, keywords, dependencies. |
| 292 | 299 |
| 293 It is also missing the ``solves`` field which is added to match the | 300 It is also missing the ``solves`` field which is added to match the |
| 294 schema. | 301 schema. |
| 295 | 302 |
| 303 `You can see the diff in the Sourceforge web interface <https://sourceforge.net/p/roundup/code/ci/54eb12cd3be143b079809795dcb2f813f75a691c/tree/share/roundup/templates/devel/html/task.index.html?diff=c95870b2bbab822def6066498a4ef8634e76e0b3>`_. | |
| 304 | |
| 296 Use @current_user in Searches (optional) | 305 Use @current_user in Searches (optional) |
| 297 ---------------------------------------- | 306 ---------------------------------------- |
| 298 | 307 |
| 299 You can create queries like: "My issues" by searching the ``creator`` | 308 You can create queries like: "My issues" by searching the ``creator`` |
| 300 property of issues for your id number. Similarly you can search for | 309 property of issues for your id number. Similarly you can search for |
| 333 <https://issues.roundup-tracker.org/issue1525113>`_. | 342 <https://issues.roundup-tracker.org/issue1525113>`_. |
| 334 | 343 |
| 335 New PostgreSQL Settings (optional) | 344 New PostgreSQL Settings (optional) |
| 336 ---------------------------------- | 345 ---------------------------------- |
| 337 | 346 |
| 338 With this release, you can specify a Postgresql database | 347 With this release, you can specify a Postgresql database schema |
| 339 schema to use. By default Roundup creates a database when | 348 to use. By default Roundup creates a database when using |
| 340 using ``roundup-admin init``. Setting the rdbms ``name`` | 349 ``roundup-admin init``. Setting the rdbms ``name`` keyword to |
| 341 keyword to ``roundup_database.roundup_schema`` will create | 350 ``roundup_database.roundup_schema`` will create and use the |
| 342 and use the ``roundup_schema`` in the pre-created | 351 ``roundup_schema`` in the pre-created ``roundup_database``. See |
| 343 ``roundup_database``. | 352 the `Roundup PostgreSQL documentation`_ for details on how to set |
| 353 up the roles. | |
| 344 | 354 |
| 345 Also there is a new configuration keyword in the rdbms | 355 Also there is a new configuration keyword in the rdbms |
| 346 section of ``config.ini``. The ``service`` keyword allows | 356 section of ``config.ini``. The ``service`` keyword allows |
| 347 you to define the service name for Postgres that will be | 357 you to define the service name for Postgres that will be |
| 348 looked up in the `Connection Service File`_. Any of the | 358 looked up in the `Connection Service File`_. Any of the |
| 1450 | 1460 |
| 1451 Then import the dump. Removing ``SET NAMES`` should allow the import | 1461 Then import the dump. Removing ``SET NAMES`` should allow the import |
| 1452 to use UTF-8. | 1462 to use UTF-8. |
| 1453 | 1463 |
| 1454 Please report success or issues with this conversion to the | 1464 Please report success or issues with this conversion to the |
| 1455 roundup-users AT lists.sourceforge.net mailing list. | 1465 roundup-users at lists.sourceforge.net mailing list. |
| 1456 | 1466 |
| 1457 As people report successful or unsuccessful conversions, we will update | 1467 As people report successful or unsuccessful conversions, we will update |
| 1458 the errata page at: https://wiki.roundup-tracker.org/ReleaseErrata. | 1468 the errata page at: https://wiki.roundup-tracker.org/ReleaseErrata. |
| 1459 | 1469 |
| 1460 Upgrade tracker's config.ini file (recommended) | 1470 Upgrade tracker's config.ini file (recommended) |
| 2571 ============================= | 2581 ============================= |
| 2572 | 2582 |
| 2573 See the `historical migration <upgrading-history.html>`_ document. | 2583 See the `historical migration <upgrading-history.html>`_ document. |
| 2574 | 2584 |
| 2575 .. _`security documentation`: security-history.html | 2585 .. _`security documentation`: security-history.html |
| 2586 .. _`Roundup postgresql documentation`: postgresql.html | |
| 2576 .. _`administration guide`: admin_guide.html | 2587 .. _`administration guide`: admin_guide.html |
| 2577 .. _`xmlrpc guide`: xmlrpc.html | 2588 .. _`xmlrpc guide`: xmlrpc.html |
| 2578 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html | 2589 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html |
| 2579 .. _PostgreSQL's full text search: https://www.postgresql.org/docs/current/textsearch.html | 2590 .. _PostgreSQL's full text search: https://www.postgresql.org/docs/current/textsearch.html |
| 2580 .. _`administration guide notes on native-fts`: admin_guide.html#configuring-native-fts-full-text-search | 2591 .. _`administration guide notes on native-fts`: admin_guide.html#configuring-native-fts-full-text-search |