Skip to content

Commit 5fd1b1b

Browse files
committed
Add allowed_api_origins to upgrading doc
In upgrading doc, also make upgrading config.ini a separate step. Fix spelling error. Also document * in allowed_api_origins in configuration.py.
1 parent 8f1fbe0 commit 5fd1b1b

File tree

2 files changed

+35
-13
lines changed

2 files changed

+35
-13
lines changed

doc/upgrading.txt

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,19 @@ Contents:
3535
Migrating from 2.1.0 to 2.x.y
3636
=============================
3737

38+
Update your ``config.ini`` (required)
39+
-------------------------------------
40+
41+
Upgrade tracker's config.ini file. Use::
42+
43+
roundup-admin -i /path/to/tracker updateconfig newconfig.ini
44+
45+
to generate a new ini file preserving all your settings. You
46+
can then merge any local comments from the tracker's
47+
``config.ini`` into ``newconfig.ini``. You can then merge
48+
comments from ``config.ini`` to ``newconfig.ini`` and
49+
replace ``config.ini`` with ``newconfig.ini``.
50+
3851
Rdbms version change from 6 to 7 (required)
3952
-------------------------------------------
4053

@@ -69,29 +82,35 @@ backends. You may want to run ``roundup-admin -i tracker_home
6982
reindex`` if you want to index or search for longer words in your full
7083
text searches. Re-indexing make take some time.
7184

72-
Check new login_empty_passwords setting
73-
---------------------------------------
85+
Check new login_empty_passwords setting (required)
86+
--------------------------------------------------
7487

7588
In this version of Roundup, users with a blank password are not
7689
allowed to login. Blank passwords have been allowed since 2002, but
7790
2022 is a different time. If you have a use case that requires a user
7891
to login without a password, set the ``login_empty_passwords`` setting
79-
in the ``web`` section of ``config.ini`` to ``yes``.
92+
in the ``web`` section of ``config.ini`` to ``yes``. In
93+
general this should be left at its default value of ``no``.
94+
95+
Check allowed_api_origins setting (optional)
96+
--------------------------------------------
97+
98+
If you are using the REST or xmlrpc api's from an origin
99+
that is different from your roundup tracker, you will need
100+
to add your allowed origins to the allowed_api_origins in
101+
your updated ``config.ini``. Upgrade your ``config.ini`` as
102+
described above then read the documentation for the setting
103+
in ``config.ini``.
80104

81105
Check compression settings (optional)
82106
-------------------------------------
83107

84108
Read the `administration guide`_ section on `Configuring Compression`_.
85109

86-
Upgrade tracker's config.ini file. Use::
87-
88-
roundup-admin -i /path/to/tracker updateconfig newconfig.ini
89-
90-
to generate a new ini file preserving all your settings. You can then
91-
merge any local comments from the tracker's ``config.ini`` into
92-
``newconfig.ini``. Compare the old and new files and configure new
93-
compression settings as you want. Then replace ``config.ini`` with the
94-
``newconfig.ini`` file.
110+
Upgrade your tracker's config.ini as described
111+
above. Compare the old and new files and configure new
112+
compression settings as you want. Then replace
113+
``config.ini`` with the ``newconfig.ini`` file.
95114

96115
Search added to user index page (optional)
97116
------------------------------------------
@@ -961,7 +980,7 @@ Support for SameSite cookie option for session cookie
961980

962981
Support for serving the session cookie using the SameSite cookie option
963982
has been added. By default it is set to lax to provide a better user
964-
experience. But this can be changes to strict or the option can be
983+
experience. But this can be changed to strict or the option can be
965984
removed entirely.
966985

967986
Using the process for merging config.ini changes described in

roundup/configuration.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1214,6 +1214,9 @@ def str2value(self, value):
12141214
'https://Bar.edu' are two different Origin values. Note that
12151215
the origin value is scheme://host. There is no path
12161216
component. So 'https://bar.edu/' would never be valid.
1217+
Also the value * can be used to match any origin. Note that
1218+
this setting allows any other web page to make requests against
1219+
your roundup tracker and is not generally a good idea.
12171220
12181221
You need to set these if you have a web application on a
12191222
different origin accessing your roundup instance.

0 commit comments

Comments
 (0)