Mercurial > p > roundup > code

comparison doc/upgrading.txt @ 6688:f1f2d59dab8b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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.
author John Rouillard <rouilj@ieee.org>
date Sun, 29 May 2022 22:37:36 -0400
parents 9ca5cbffa0c4
children b56bd672ebbf
comparison
equal deleted inserted replaced
6687:c68739264869 6688:f1f2d59dab8b
32 32
33 .. index:: Upgrading; 2.0.0 to 2.1.0 33 .. index:: Upgrading; 2.0.0 to 2.1.0
34 34
35 Migrating from 2.1.0 to 2.x.y 35 Migrating from 2.1.0 to 2.x.y
36 ============================= 36 =============================
37
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``.
37 50
38 Rdbms version change from 6 to 7 (required) 51 Rdbms version change from 6 to 7 (required)
39 ------------------------------------------- 52 -------------------------------------------
40 53
41 This release includes two changes that require updates to the database 54 This release includes two changes that require updates to the database
67 The increase in indexed word length also affects whoosh and xapian 80 The increase in indexed word length also affects whoosh and xapian
68 backends. You may want to run ``roundup-admin -i tracker_home 81 backends. You may want to run ``roundup-admin -i tracker_home
69 reindex`` if you want to index or search for longer words in your full 82 reindex`` if you want to index or search for longer words in your full
70 text searches. Re-indexing make take some time. 83 text searches. Re-indexing make take some time.
71 84
72 Check new login_empty_passwords setting 85 Check new login_empty_passwords setting (required)
73 --------------------------------------- 86 --------------------------------------------------
74 87
75 In this version of Roundup, users with a blank password are not 88 In this version of Roundup, users with a blank password are not
76 allowed to login. Blank passwords have been allowed since 2002, but 89 allowed to login. Blank passwords have been allowed since 2002, but
77 2022 is a different time. If you have a use case that requires a user 90 2022 is a different time. If you have a use case that requires a user
78 to login without a password, set the ``login_empty_passwords`` setting 91 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``.
80 104
81 Check compression settings (optional) 105 Check compression settings (optional)
82 ------------------------------------- 106 -------------------------------------
83 107
84 Read the `administration guide`_ section on `Configuring Compression`_. 108 Read the `administration guide`_ section on `Configuring Compression`_.
85 109
86 Upgrade tracker's config.ini file. Use:: 110 Upgrade your tracker's config.ini as described
87 111 above. Compare the old and new files and configure new
88 roundup-admin -i /path/to/tracker updateconfig newconfig.ini 112 compression settings as you want. Then replace
89 113 ``config.ini`` with the ``newconfig.ini`` file.
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.
95 114
96 Search added to user index page (optional) 115 Search added to user index page (optional)
97 ------------------------------------------ 116 ------------------------------------------
98 117
99 A search form and count of number of hits has been added to the 118 A search form and count of number of hits has been added to the
959 Support for SameSite cookie option for session cookie 978 Support for SameSite cookie option for session cookie
960 ----------------------------------------------------- 979 -----------------------------------------------------
961 980
962 Support for serving the session cookie using the SameSite cookie option 981 Support for serving the session cookie using the SameSite cookie option
963 has been added. By default it is set to lax to provide a better user 982 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
965 removed entirely. 984 removed entirely.
966 985
967 Using the process for merging config.ini changes described in 986 Using the process for merging config.ini changes described in
968 `Cross Site Request Forgery Detection Added`_ you can add the 987 `Cross Site Request Forgery Detection Added`_ you can add the
969 ``samesite_cookie_setting`` to the ``[web]`` section of the config 988 ``samesite_cookie_setting`` to the ``[web]`` section of the config
Roundup Issue Tracker: http://roundup-tracker.org/