Skip to content

Commit ffe8b6e

Browse files
committed
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.
1 parent 2c8c3b5 commit ffe8b6e

File tree

2 files changed

+32
-19
lines changed

2 files changed

+32
-19
lines changed

doc/postgresql.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ list.
4848
Creating a Role/User
4949
--------------------
5050

51-
For case 1 create a user using::
51+
For case 1 (Roundup user creates and uses a database) create a user
52+
using::
5253

5354
psql -c "CREATE ROLE roundupuser WITH CREATEDB LOGIN PASSWORD 'rounduppw';" -U postgres
5455

@@ -60,7 +61,8 @@ remove the CREATEDB permission using::
6061
If needed (e.g. you want to deploy a new tracker) you can use ``ALTER
6162
ROLE`` with ``CREATEDB`` to add the permission back.
6263

63-
For case 2 you need to create the user::
64+
For case 2 (Roundup user uses a schema under a pre-created database)
65+
you need to create the user::
6466

6567
psql -c "CREATE ROLE roundupuser LOGIN PASSWORD 'rounduppw';" -U postgres
6668

doc/upgrading.txt

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -237,20 +237,27 @@ production workloads so we count on users to help us with this.
237237
Disable performance improvement for wsgi mode (optional)
238238
--------------------------------------------------------
239239

240-
In Roundup version 2.2.0 an experimental option to improve performance
241-
when running in wsgi mode was added. It as disabled at that time. In
242-
the last two years it has been in use at a few sits with no reports of
243-
issues.
244-
245-
So the default mode is now to enable this improvement. This will get
246-
more people using it. In case there is a latent bug that hasn't been
247-
discovered, it can still be disabled. To disable it, add the
248-
feature_flags to the RequestDispatcher as below:
240+
In Roundup version 2.2.0, an experimental feature was introduced to
241+
enhance performance while operating in wsgi mode. Initially, this
242+
feature was disabled. Over the past two years, it has been used at a
243+
few sites without any reported problems.
244+
245+
As a result, the default setting now enables this performance
246+
improvement, encouraging a wider adoption of the feature. In the
247+
event that an undiscovered bug arises, it can still be disabled
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:
249251

250252
feature_flags = { "cache_tracker": False }
251253
app = RequestDispatcher(tracker_home, feature_flags=feature_flags)
252254

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.
254261

255262
Fix duplicate id for confirm password in user.item.html (optional)
256263
------------------------------------------------------------------
@@ -293,6 +300,8 @@ The removed columns are: severity, versions, keywords, dependencies.
293300
It is also missing the ``solves`` field which is added to match the
294301
schema.
295302

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+
296305
Use @current_user in Searches (optional)
297306
----------------------------------------
298307

@@ -335,12 +344,13 @@ should change it. `Details can be found in issue1525113
335344
New PostgreSQL Settings (optional)
336345
----------------------------------
337346

338-
With this release, you can specify a Postgresql database
339-
schema to use. By default Roundup creates a database when
340-
using ``roundup-admin init``. Setting the rdbms ``name``
341-
keyword to ``roundup_database.roundup_schema`` will create
342-
and use the ``roundup_schema`` in the pre-created
343-
``roundup_database``.
347+
With this release, you can specify a Postgresql database schema
348+
to use. By default Roundup creates a database when using
349+
``roundup-admin init``. Setting the rdbms ``name`` keyword to
350+
``roundup_database.roundup_schema`` will create and use the
351+
``roundup_schema`` in the pre-created ``roundup_database``. See
352+
the `Roundup PostgreSQL documentation`_ for details on how to set
353+
up the roles.
344354

345355
Also there is a new configuration keyword in the rdbms
346356
section of ``config.ini``. The ``service`` keyword allows
@@ -1452,7 +1462,7 @@ Then import the dump. Removing ``SET NAMES`` should allow the import
14521462
to use UTF-8.
14531463

14541464
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.
14561466

14571467
As people report successful or unsuccessful conversions, we will update
14581468
the errata page at: https://wiki.roundup-tracker.org/ReleaseErrata.
@@ -2573,6 +2583,7 @@ Migrating from older versions
25732583
See the `historical migration <upgrading-history.html>`_ document.
25742584

25752585
.. _`security documentation`: security-history.html
2586+
.. _`Roundup postgresql documentation`: postgresql.html
25762587
.. _`administration guide`: admin_guide.html
25772588
.. _`xmlrpc guide`: xmlrpc.html
25782589
.. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html

0 commit comments

Comments
 (0)