changeset 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 1505f6ab86ec
children 828f79ae965b
files doc/postgresql.txt doc/upgrading.txt
diffstat 2 files changed, 32 insertions(+), 19 deletions(-) [+]
line wrap: on
line diff
--- a/doc/postgresql.txt	Sun May 12 23:53:49 2024 -0400
+++ b/doc/postgresql.txt	Mon May 13 13:32:02 2024 -0400
@@ -48,7 +48,8 @@
 Creating a Role/User
 --------------------
 
-For case 1 create a user using::
+For case 1 (Roundup user creates and uses a database) create a user
+using::
 
   psql -c "CREATE ROLE roundupuser WITH CREATEDB LOGIN PASSWORD 'rounduppw';" -U postgres
 
@@ -60,7 +61,8 @@
 If needed (e.g. you want to deploy a new tracker) you can use ``ALTER
 ROLE`` with ``CREATEDB`` to add the permission back.
 
-For case 2 you need to create the user:: 
+For case 2 (Roundup user uses a schema under a pre-created database)
+you need to create the user::
 
   psql -c "CREATE ROLE roundupuser LOGIN PASSWORD 'rounduppw';" -U postgres
 
--- a/doc/upgrading.txt	Sun May 12 23:53:49 2024 -0400
+++ b/doc/upgrading.txt	Mon May 13 13:32:02 2024 -0400
@@ -237,20 +237,27 @@
 Disable performance improvement for wsgi mode (optional)
 --------------------------------------------------------
 
-In Roundup version 2.2.0 an experimental option to improve performance
-when running in wsgi mode was added. It as disabled at that time. In
-the last two years it has been in use at a few sits with no reports of
-issues.
-
-So the default mode is now to enable this improvement. This will get
-more people using it. In case there is a latent bug that hasn't been
-discovered, it can still be disabled. To disable it, add the
-feature_flags to the RequestDispatcher as below:
+In Roundup version 2.2.0, an experimental feature was introduced to
+enhance performance while operating in wsgi mode. Initially, this
+feature was disabled. Over the past two years, it has been used at a
+few sites without any reported problems.
+
+As a result, the default setting now enables this performance
+improvement, encouraging a wider adoption of the feature. In the
+event that an undiscovered bug arises, it can still be disabled
+if you experience problems. To disable it, modify your wsgi
+startup script and add the feature_flags to the RequestDispatcher
+as below:
 
    feature_flags = { "cache_tracker": False }
    app =  RequestDispatcher(tracker_home, feature_flags=feature_flags)
 
-and restart your wsgi instance.
+Then restart your wsgi instance. If you have to disable this
+feature, send email to the roundup-users mailing list
+(roundup-users at lists.sourceforge.net) so we can help you
+diagnose the cause and fix it for everybody.
+
+In the future, support for disabling this improvement will be removed.
 
 Fix duplicate id for confirm password in user.item.html (optional)
 ------------------------------------------------------------------
@@ -293,6 +300,8 @@
 It is also missing the ``solves`` field which is added to match the
 schema.
 
+`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>`_.
+
 Use @current_user in Searches (optional)
 ----------------------------------------
 
@@ -335,12 +344,13 @@
 New PostgreSQL Settings (optional)
 ----------------------------------
 
-With this release, you can specify a Postgresql database
-schema to use. By default Roundup creates a database when
-using ``roundup-admin init``. Setting the rdbms ``name``
-keyword to ``roundup_database.roundup_schema`` will create
-and use the ``roundup_schema`` in the pre-created
-``roundup_database``.
+With this release, you can specify a Postgresql database schema
+to use. By default Roundup creates a database when using
+``roundup-admin init``. Setting the rdbms ``name`` keyword to
+``roundup_database.roundup_schema`` will create and use the
+``roundup_schema`` in the pre-created ``roundup_database``. See
+the `Roundup PostgreSQL documentation`_ for details on how to set
+up the roles.
 
 Also there is a new configuration keyword in the rdbms
 section of ``config.ini``. The ``service`` keyword allows
@@ -1452,7 +1462,7 @@
 to use UTF-8.
 
 Please report success or issues with this conversion to the
-roundup-users AT lists.sourceforge.net mailing list.
+roundup-users at lists.sourceforge.net mailing list.
 
 As people report successful or unsuccessful conversions, we will update
 the errata page at: https://wiki.roundup-tracker.org/ReleaseErrata.
@@ -2573,6 +2583,7 @@
 See the `historical migration <upgrading-history.html>`_ document.
 
 .. _`security documentation`: security-history.html
+.. _`Roundup postgresql documentation`: postgresql.html
 .. _`administration guide`: admin_guide.html
 .. _`xmlrpc guide`: xmlrpc.html
 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html

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