Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 7321:e21c7fe0b57a
Move text into notes; add references to historic upgrade directions
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 11 May 2023 13:38:13 -0400 |
| parents | c3b0fd62b0b8 |
| children | 7321c0e6c53e |
comparison
equal
deleted
inserted
replaced
| 7320:209e94ed0277 | 7321:e21c7fe0b57a |
|---|---|
| 12 | 12 |
| 13 Please read each section carefully and edit the files in your tracker home | 13 Please read each section carefully and edit the files in your tracker home |
| 14 accordingly. Note that there is information about upgrade procedures in the | 14 accordingly. Note that there is information about upgrade procedures in the |
| 15 `administration guide`_ in the `Software Upgrade`_ section. | 15 `administration guide`_ in the `Software Upgrade`_ section. |
| 16 | 16 |
| 17 If a specific version transition isn't mentioned here (e.g. 0.6.7 to 0.6.8) | 17 If a specific version transition isn't mentioned here (e.g. 0.6.7 to |
| 18 then you don't need to do anything. If you're upgrading from 0.5.6 to | 18 0.6.8) then you don't need to do anything. If you're upgrading from |
| 19 0.6.8 though, you'll need to apply the "0.5 to 0.6" and "0.6.x to 0.6.3" | 19 0.5.6 to 0.6.8 though, you'll need to apply the "0.5 to 0.6" and |
| 20 steps. | 20 "0.6.x to 0.6.3" steps. |
| 21 | 21 |
| 22 General steps: | 22 General steps: |
| 23 | 23 |
| 24 1. Make note of your current Roundup version. | 24 1. Make note of your current Roundup version. |
| 25 2. Take your Roundup installation offline (web, email, | 25 2. Take your Roundup installation offline (web, email, |
| 37 version of Roundup for **all** the trackers you have | 37 version of Roundup for **all** the trackers you have |
| 38 upgraded. This will update the database if it is required. | 38 upgraded. This will update the database if it is required. |
| 39 7. Bring your Roundup instance back online | 39 7. Bring your Roundup instance back online |
| 40 8. Test | 40 8. Test |
| 41 | 41 |
| 42 **IMPORTANT** The v1.5.x releases of Roundup were the last to support | 42 .. note:: |
| 43 Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup | 43 The v1.5.x releases of Roundup were the last to support |
| 44 Python version 2.7 that is newer than 2.7.2 is required to run | 44 Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup |
| 45 Roundup. Starting with Roundup version 2.0.0 we also support Python 3 | 45 Python version 2.7 that is newer than 2.7.2 is required to run |
| 46 versions newer than 3.6. | 46 Roundup. Starting with Roundup version 2.0.0 we also support Python 3 |
| 47 versions newer than 3.6. | |
| 47 | 48 |
| 48 Recent release notes have the following labels: | 49 Recent release notes have the following labels: |
| 49 | 50 |
| 50 * required - Roundup will not work properly if these steps are not done | 51 * required - Roundup will not work properly if these steps are not done |
| 51 * recommended - Roundup will still work, but these steps can cause | 52 * recommended - Roundup will still work, but these steps can cause |
| 57 If you use virtual environments for your installation, you can run | 58 If you use virtual environments for your installation, you can run |
| 58 trackers with different versions of Roundup. So you can have one tracker | 59 trackers with different versions of Roundup. So you can have one tracker |
| 59 using version 2.2.0 and another tracker using version 1.6.1. This | 60 using version 2.2.0 and another tracker using version 1.6.1. This |
| 60 allows you to upgrade trackers one at a time rather than having to | 61 allows you to upgrade trackers one at a time rather than having to |
| 61 upgrade all your trackers at once. | 62 upgrade all your trackers at once. |
| 63 | |
| 64 .. note:: | |
| 65 | |
| 66 This file only includes versions released in the last 10 | |
| 67 years. If you are upgrading from an older version, start with the | |
| 68 changes in the `historical migration <upgrading-history.html>`_ | |
| 69 document. | |
| 62 | 70 |
| 63 Contents: | 71 Contents: |
| 64 | 72 |
| 65 .. contents:: | 73 .. contents:: |
| 66 :local: | 74 :local: |
| 1974 self.client.add_error_message(...) | 1982 self.client.add_error_message(...) |
| 1975 | 1983 |
| 1976 The new calls escape the passed string by default and avoid XSS security | 1984 The new calls escape the passed string by default and avoid XSS security |
| 1977 issues. | 1985 issues. |
| 1978 | 1986 |
| 1987 | |
| 1988 Migrating from older versions | |
| 1989 ============================= | |
| 1990 | |
| 1991 See the `historical migration <upgrading-history.html>`_ document. | |
| 1992 | |
| 1979 .. _`customisation documentation`: customizing.html | 1993 .. _`customisation documentation`: customizing.html |
| 1980 .. _`security documentation`: security-history.html | 1994 .. _`security documentation`: security-history.html |
| 1981 .. _`administration guide`: admin_guide.html | 1995 .. _`administration guide`: admin_guide.html |
| 1982 .. _`xmlrpc guide`: xmlrpc.html | 1996 .. _`xmlrpc guide`: xmlrpc.html |
| 1983 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html | 1997 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html |