Changes between Version 1 and Version 2 of TracUpgrade
- Timestamp:
- 02/19/15 14:27:32 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracUpgrade
v1 v2 1 1 = Upgrade Instructions = 2 2 [[TracGuideToc]] 3 [[PageOutline(2-4,,inline,unnumbered)]] 3 4 4 5 == Instructions == … … 6 7 Typically, there are seven steps involved in upgrading to a newer version of Trac: 7 8 8 === 1. Update the Trac Code === #UpdatetheTracCode 9 === 1. Bring your server off-line 10 11 It is not a good idea to update a running server: the server processes may have parts of the current packages cached in memory, and updating the code will likely trigger [#ZipImportError internal errors]. 12 13 === 2. Update the Trac Code === #UpdatetheTracCode 9 14 10 15 Get the new version as described in TracInstall, or your operating system specific procedure. 11 16 12 If you already have a 0.1 1version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:13 14 {{{ 15 # easy_install --upgrade Trac== 0.1217 If you already have a 0.12 version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation: 18 19 {{{ 20 # easy_install --upgrade Trac==1.0 16 21 }}} 17 22 … … 24 29 * on MacOSX: `/Library/Python/2.X/site-packages` 25 30 26 You may also want to remove the Trac `cgi-bin`, `htdocs`, `templates` and `wiki-default` directories that are commonly found in a directory called `share/trac`. (The exact location depends on your platform.) 27 28 This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as you won't waste your time looking at code or templates from a previous release that are not being used anymore... As usual, make a backup before actually deleting things. 29 30 === 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment 31 You may also want to remove the Trac `cgi-bin`, `htdocs`, `templates` and `wiki-default` directories that are commonly found in a directory called `share/trac`. The exact location depends on your platform. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before actually removing things. 32 33 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment 31 34 32 35 Environment upgrades are not necessary for minor version releases unless otherwise noted. … … 40 43 41 44 Note that a backup of your database will be performed automatically prior to the upgrade. 42 This feature is relatively new for the PostgreSQL or MySQL database backends, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:45 This feature is relatively new for PostgreSQL or MySQL databases, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run: 43 46 {{{ 44 47 trac-admin /path/to/projenv upgrade --no-backup 45 48 }}} 46 49 47 === 3. Update the Trac Documentation === #UpdatetheTracDocumentation48 49 Every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. As you probably want to keep the included documentation in sync with the installed version of Trac, [TracAdmin trac-admin] provides acommand to upgrade the documentation:50 === 4. Update the Trac Documentation === #UpdatetheTracDocumentation 51 52 By default, every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. However, to keep the included documentation in sync with the installed version of Trac, use the following [TracAdmin trac-admin] command to upgrade the documentation: 50 53 {{{ 51 54 trac-admin /path/to/projenv wiki upgrade … … 54 57 Note that this procedure will leave your `WikiStart` page intact. 55 58 56 === 4. Resynchronize the Trac Environment Against the Source Code Repository ===57 58 Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[http://trac.edgewall.org/ticket/6120 No changeset ??? in the repository]" while browsing the source through the Trac interface:59 60 {{{61 trac-admin /path/to/projenv repository resync '*'62 }}}63 64 59 === 5. Refresh static resources === 65 60 … … 70 65 this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`. 71 66 72 Some web browsers cache CSS and Javascript files persistently, so you may need to instruct your users to manually erase the contents of their browser's cache. 67 Some web browsers (IE, Opera) cache CSS and Javascript files aggressively, so you may need to instruct your users to manually erase the contents of their browser's cache, a forced refreshed (`<F5>`) should be enough. 68 {{{#!comment 69 Remove above note once #9936 is fixed. 70 }}} 73 71 74 72 === 6. Steps specific to a given Trac version === 73 74 ==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0 75 76 ===== Python 2.4 no longer supported ===== 77 Upgrade Python to at least 2.5, but not 3.0. 78 79 ===== Subversion components not enabled by default for new installations 80 The Trac components for Subversion support are no longer enabled by default. To enable the svn support, you need to make sure the `tracopt.versioncontrol.svn` components are enabled, for example by setting the following in the TracIni: 81 {{{ 82 [components] 83 tracopt.versioncontrol.svn.* = enabled 84 }}} 85 The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled. 86 87 ===== Attachments migrated to new location 88 Another step in the automatic upgrade will change the way the attachments are stored. Create a backup of the `attachments` directory before upgrading. In case the `attachments` directory contains some files which are //not// attachments, the last step of the migration to the new layout will fail: the deletion of the now unused `attachments` directory can't be done if there are still files and folders in it. You may ignore this error, but better to move them elsewhere and remove the `attachments` directory manually. The attachments themselves are now all located in your environment below the `files/attachments` directory. 89 90 ===== Behavior of `[ticket] default_owner` changed 91 Prior to 1.0, the owner field of new tickets always defaulted to `[ticket] default_owner` when the value was not empty. If the value was empty, the owner field defaulted to to the Component's owner. In 1.0 and later, the `default_owner` must be set to `< default >` to make new tickets default to the Component's owner. This change allows the `default_owner` to be set to an empty value if no default owner is desired. 92 75 93 ==== Upgrading from Trac 0.11 to Trac 0.12 ==== 94 76 95 ===== Python 2.3 no longer supported ===== 77 The minimum supported version of python is now 2.496 The minimum supported version of Python is now 2.4. 78 97 79 98 ===== SQLite v3.x required ===== … … 81 100 82 101 ===== PySqlite 2 required ===== 83 PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below).102 PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below. 84 103 85 104 ===== Multiple Repository Support ===== 86 105 The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. 87 106 88 This may be of interest to users with only one repository, since there's now a way to avoid the potentially costly resync check at every request. 107 This may be of interest to users with only one repository, since there is now a way to avoid the potentially costly resync check at every request. 108 109 ===== Resynchronize the Trac Environment Against the Source Code Repository ===== 110 111 Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[trac:#6120 No changeset ??? in the repository]" while browsing the source through the Trac interface: 112 113 {{{ 114 trac-admin /path/to/projenv repository resync '*' 115 }}} 89 116 90 117 ===== Improved repository synchronization ===== … … 93 120 While you can keep the same synchronization as in 0.11 adding the post-commit hook as outlined in TracRepositoryAdmin#Synchronization and TracRepositoryAdmin#ExplicitSync will allow more efficient synchronization and is more or less required for multiple repositories. 94 121 95 Note that if you were using the `trac-post-commit-hook`, ''you're strongly advised to upgrade it'' to the new hook documented in the above references , as the old hook will not work with anything else than the default repository and even for this case, it won't trigger the appropriate notifications.122 Note that if you were using the `trac-post-commit-hook`, ''you're strongly advised to upgrade it'' to the new hook documented in the above references and [TracWorkflow#Howtocombinethetracopt.ticket.commit_updaterwiththetestingworkflow here], as the old hook will not work with anything else than the default repository and even for this case, it won't trigger the appropriate notifications. 96 123 97 124 ===== Authz permission checking ===== 98 The authz permission checking has been migrated to a fine-grained permission policy. If you use authz permissions (aka `[trac] authz_file` and `authz_module_name`), you must add `AuthzSourcePolicy` in front of your permission policies in `[trac] permission_policies`. You must also remove `BROWSER_VIEW`, `CHANGESET_VIEW`, `FILE_VIEW` and `LOG_VIEW` from your global permissions (with `trac-admin $ENV permission remove` or the "Permissions" admin panel).125 The authz permission checking has been migrated to a fine-grained permission policy. If you use authz permissions (aka `[trac] authz_file` and `authz_module_name`), you must add `AuthzSourcePolicy` in front of your permission policies in `[trac] permission_policies`. You must also remove `BROWSER_VIEW`, `CHANGESET_VIEW`, `FILE_VIEW` and `LOG_VIEW` from your global permissions with `trac-admin $ENV permission remove` or the "Permissions" admin panel. 99 126 100 127 ===== Microsecond timestamps ===== 101 All timestamps in database tables (except the `session` table)have been changed from "seconds since epoch" to "microseconds since epoch" values. This change should be transparent to most users, except for custom reports. If any of your reports use date/time columns in calculations (e.g. to pass them to `datetime()`), you must divide the values retrieved from the database by 1'000'000. Similarly, if a report provides a calculated value to be displayed as a date/time (i.e. with a column named "time", "datetime", "changetime", "date", "created" or "modified"), you must provide a microsecond timestamp, that is, multiply your previous calculation with 1'000'000.128 All timestamps in database tables, except the `session` table, have been changed from "seconds since epoch" to "microseconds since epoch" values. This change should be transparent to most users, except for custom reports. If any of your reports use date/time columns in calculations (e.g. to pass them to `datetime()`), you must divide the values retrieved from the database by 1'000'000. Similarly, if a report provides a calculated value to be displayed as a date/time (i.e. with a column named "time", "datetime", "changetime", "date", "created" or "modified"), you must provide a microsecond timestamp, that is, multiply your previous calculation with 1'000'000. 102 129 103 130 ==== Upgrading from Trac 0.10 to Trac 0.11 ==== … … 105 132 The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. 106 133 107 If you are using custom CSS stylesor modified templates in the `templates` directory of the TracEnvironment, you will need to convert them to the Genshi way of doing things. To continue to use your style sheet, follow the instructions at TracInterfaceCustomization#SiteAppearance.134 If you are using custom CSS or modified templates in the `templates` directory of the TracEnvironment, you will need to convert them to the Genshi way of doing things. To continue to use your style sheet, follow the instructions at TracInterfaceCustomization#SiteAppearance. 108 135 109 136 ===== Trac Macros, Plugins ===== 110 The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of [trac:ClearSilver] and the HDF); they need to be converted to the new-style macros, see WikiMacros. When they are converted to the new style, they need to be placed into the plugins directory instead and not wiki-macros, which is no longer scanned for macros or plugins.137 The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore due to the drop of [trac:ClearSilver] and the HDF. They need to be converted to the new-style macros, see WikiMacros. When they are converted to the new style, they need to be placed into the plugins directory instead and not wiki-macros, which is no longer scanned for macros or plugins. 111 138 112 139 ===== For FCGI/WSGI/CGI users ===== … … 121 148 If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11. 122 149 150 ===== New Default Configurable Workflow 151 152 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10. 153 154 Graphically, that looks like this: 155 156 {{{#!Workflow width=500 height=240 157 leave = * -> * 158 leave.operations = leave_status 159 leave.default = 1 160 accept = new -> assigned 161 accept.permissions = TICKET_MODIFY 162 accept.operations = set_owner_to_self 163 resolve = new,assigned,reopened -> closed 164 resolve.permissions = TICKET_MODIFY 165 resolve.operations = set_resolution 166 reassign = new,assigned,reopened -> new 167 reassign.permissions = TICKET_MODIFY 168 reassign.operations = set_owner 169 reopen = closed -> reopened 170 reopen.permissions = TICKET_CREATE 171 reopen.operations = del_resolution 172 }}} 173 174 There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful. See TracWorkflow for a detailed description of the new basic workflow. 175 123 176 === 7. Restart the Web Server === #RestarttheWebServer 124 177 … … 127 180 == Known Issues == 128 181 129 === parent dir === 130 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work. 182 === Customized Templates 183 184 Trac supports customization of its Genshi templates by placing copies of the templates in the `<env>/templates` folder of your [TracEnvironment environment] or in a common location specified in the [[TracIni#GlobalConfiguration| [inherit] templates_dir]] configuration setting. If you choose to do so, be aware that you will need to repeat your changes manually on a copy of the new templates when you upgrade to a new release of Trac (even a minor one), as the templates will likely evolve. So keep a diff around. 185 186 The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation, as this is more robust in case of changes: we usually won't modify element `id`s or change CSS `class`es, and if we have to do so, this will be documented in the TracDev/ApiChanges pages. 187 188 === !ZipImportError === 189 190 Due to internal caching of zipped packages, whenever the content of the packages change on disk, the in-memory zip index will no longer match and you'll get irrecoverable !ZipImportError errors. Better anticipate and bring your server down for maintenance before upgrading. 191 See [trac:#7014] for details. 131 192 132 193 === Wiki Upgrade === … … 137 198 A known issue in some versions of PySqlite (2.5.2-2.5.4) prevents the trac-admin upgrade script from successfully upgrading the database format. It is advised to use either a newer or older version of the sqlite python bindings to avoid this error. For more details see ticket [trac:#9434]. 138 199 139 == Upgrading Python == 140 141 Upgrading Python to a newer version will require reinstallation of Python packages: Trac of course; also [http://pypi.python.org/pypi/setuptools easy_install], if you've been using that. Assuming you're using Subversion, you'll also need to upgrade the Python bindings for svn. 142 143 === Windows and Python 2.6 === 144 145 If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [http://alagazam.net/ Algazam], which has the Python bindings readily available (see TracSubversion). The good news is, that works with no tweaking. 146 147 == Changing Database Backend == 148 === SQLite to PostgreSQL === 149 150 The [http://trac-hacks.org/wiki/SqliteToPgScript sqlite2pg] script on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating a SQLite database to a PostgreSQL database 151 152 == Older Versions == 200 === Parent dir === 201 If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work. 202 203 == Related topics 204 205 === Upgrading Python === 206 207 Upgrading Python to a newer version will require reinstallation of Python packages: Trac itself of course, but also [http://pypi.python.org/pypi/setuptools easy_install], if you've been using that. If you are using Subversion, you'll also need to upgrade the Python bindings for svn. 208 209 ==== Windows and Python 2.6 ==== 210 211 If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [http://alagazam.net/ Alagazam], which has the Python bindings readily available, see TracSubversion. That package works without tweaking. 212 213 === Changing Database Backend === 214 215 The [http://trac-hacks.org/wiki/TracMigratePlugin TracMigratePlugin] on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating between SQLite, MySQL and PostgreSQL databases. 216 217 === Upgrading from older versions of Trac === #OlderVersions 153 218 154 219 For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
