Changes between Version 5 and Version 6 of TracUpgrade
- Timestamp:
- Jan 12, 2016, 11:21:52 PM (3 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracUpgrade
v5 v6 1 = Upgrade Instructions 1 = Upgrade Instructions = 2 2 [[TracGuideToc]] 3 3 [[PageOutline(2-4,,inline,unnumbered)]] 4 4 5 == Instructions 5 == Instructions == 6 6 7 7 Typically, there are seven steps involved in upgrading to a newer version of Trac: … … 9 9 === 1. Bring your server off-line 10 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]. 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 12 13 Although a database backup will be implicitly created by default when upgrading the environment, it is always a good idea to perform a full backup of the environment using the [TracBackup hotcopy] command before beginning. 14 15 === 2. Update the Trac Code #UpdatetheTracCode 13 === 2. Update the Trac Code === #UpdatetheTracCode 16 14 17 15 Get the new version as described in TracInstall, or your operating system specific procedure. 18 16 19 If you already have a 0.1 2version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:17 If you already have a 0.11 version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation: 20 18 21 {{{ #!sh22 easy_install --upgrade Trac==1.0 19 {{{ 20 # easy_install --upgrade Trac==0.12 23 21 }}} 24 22 … … 31 29 * on MacOSX: `/Library/Python/2.X/site-packages` 32 30 33 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.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.) 34 32 35 === 3. Upgrade the Trac Environment #UpgradetheTracEnvironment 33 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. 34 35 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment 36 36 37 37 Environment upgrades are not necessary for minor version releases unless otherwise noted. 38 38 39 39 After restarting, Trac should show the instances which need a manual upgrade via the automated upgrade scripts to ease the pain. These scripts are run via [TracAdmin trac-admin]: 40 {{{ #!sh40 {{{ 41 41 trac-admin /path/to/projenv upgrade 42 42 }}} … … 45 45 46 46 Note that a backup of your database will be performed automatically prior to the upgrade. 47 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:48 {{{ #!sh47 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: 48 {{{ 49 49 trac-admin /path/to/projenv upgrade --no-backup 50 50 }}} … … 52 52 === 4. Update the Trac Documentation === #UpdatetheTracDocumentation 53 53 54 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:55 {{{ #!sh54 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 a command to upgrade the documentation: 55 {{{ 56 56 trac-admin /path/to/projenv wiki upgrade 57 57 }}} … … 59 59 Note that this procedure will leave your `WikiStart` page intact. 60 60 61 === 5. Refresh static resources 61 62 === 5. Refresh static resources === 62 63 63 64 If you have set up a web server to give out static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the same command: 64 {{{ #!sh65 {{{ 65 66 trac-admin /path/to/env deploy /deploy/path 66 67 }}} … … 72 73 }}} 73 74 74 === 6. Steps specific to a given Trac version 75 === 6. Steps specific to a given Trac version === 76 ==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0 75 77 76 ==== Upgrading from Trac 0.12 to Trac 1.0 #to1.077 78 ===== Python 2.4 no longer supported79 Upgrade Python to at least 2.5, but not 3.0.80 81 ===== Obsolete Plugins82 83 Trac has added functionality equivalent to the following plugins:84 85 * [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]86 * [https://trac-hacks.org/wiki/GitPlugin GitPlugin]87 * [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]88 89 The plugins should be removed when upgrading Trac to 1.0.90 91 ===== Subversion components not enabled by default for new installations92 78 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: 93 {{{ #!ini79 {{{ 94 80 [components] 95 81 tracopt.versioncontrol.svn.* = enabled … … 97 83 The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled. 98 84 99 ===== Attachments migrated to new location 100 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. 85 Another step in the automatic upgrade will change the way the attachments are stored. If you're a bit paranoid, you might want to take a backup of the `attachments` directory before upgrading (but if you are, you already did a full copy of the environment, no?). 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 go have a look to these files, move them elsewhere and remove the `attachments` directory manually to cleanup the environment. The attachments themselves are now all located in your environment below the `files/attachments` directory. 101 86 102 ===== Behavior of `[ticket] default_owner` changed103 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.104 87 105 ==== Upgrading from Trac 0.11 to Trac 0.12 88 ==== Upgrading from Trac 0.11 to Trac 0.12 ==== 106 89 107 ===== Python 2.3 no longer supported 108 The minimum supported version of Python is now 2.4.90 ===== Python 2.3 no longer supported ===== 91 The minimum supported version of python is now 2.4 109 92 110 ===== SQLite v3.x required 93 ===== SQLite v3.x required ===== 111 94 SQLite v2.x is no longer supported. If you still use a Trac database of this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details. 112 95 113 ===== [trac:PySqlite] 2 required114 [trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.96 ===== PySqlite 2 required ===== 97 PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below). 115 98 116 ===== Obsolete Plugins 117 118 Trac has added functionality equivalent to the following plugins: 119 120 * [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin] 121 * [https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch] 122 * [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors 123 * [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission] 124 * [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter` 125 * [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories 126 * [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole] 127 * [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1) 128 129 The plugins should be removed when upgrading Trac to 0.12. 130 131 ===== Multiple Repository Support 99 ===== Multiple Repository Support ===== 132 100 The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. 133 101 134 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.102 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. 135 103 136 ===== Resynchronize the Trac Environment Against the Source Code Repository 104 ===== Resynchronize the Trac Environment Against the Source Code Repository ===== 137 105 138 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:106 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: 139 107 140 {{{ #!sh108 {{{ 141 109 trac-admin /path/to/projenv repository resync '*' 142 110 }}} 143 111 144 ===== Improved repository synchronization 112 ===== Improved repository synchronization ===== 145 113 In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. 146 114 … … 149 117 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. 150 118 151 ===== Authz permission checking 152 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.119 ===== Authz permission checking ===== 120 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). 153 121 154 ===== Microsecond timestamps 155 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.122 ===== Microsecond timestamps ===== 123 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. 156 124 157 ==== Upgrading from Trac 0.10 to Trac 0.11 158 ===== Site Templates and Styles 125 ==== Upgrading from Trac 0.10 to Trac 0.11 ==== 126 ===== Site Templates and Styles ===== 159 127 The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. 160 128 161 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.129 If you are using custom CSS styles 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. 162 130 163 ===== Trac Macros, Plugins 164 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.131 ===== Trac Macros, Plugins ===== 132 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. 165 133 166 ===== For FCGI/WSGI/CGI users 134 ===== For FCGI/WSGI/CGI users ===== 167 135 For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: 168 {{{ #!sh136 {{{ 169 137 trac-admin /path/to/env deploy /deploy/directory/path 170 138 }}} … … 172 140 This will create a deploy directory with the following two subdirectories: `cgi-bin` and `htdocs`. Then update your Apache configuration file `httpd.conf` with this new `trac.cgi` location and `htdocs` location. 173 141 174 ===== Web Admin plugin integrated 175 If you had the [trac:WebAdmin]plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.142 ===== Web Admin plugin integrated ===== 143 If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11. 176 144 177 ===== New Default Configurable Workflow 178 179 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. 180 181 Graphically, that looks like this: 182 183 {{{#!Workflow width=500 height=240 184 leave = * -> * 185 leave.operations = leave_status 186 leave.default = 1 187 accept = new -> assigned 188 accept.permissions = TICKET_MODIFY 189 accept.operations = set_owner_to_self 190 resolve = new,assigned,reopened -> closed 191 resolve.permissions = TICKET_MODIFY 192 resolve.operations = set_resolution 193 reassign = new,assigned,reopened -> new 194 reassign.permissions = TICKET_MODIFY 195 reassign.operations = set_owner 196 reopen = closed -> reopened 197 reopen.permissions = TICKET_CREATE 198 reopen.operations = del_resolution 199 }}} 200 201 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. 202 203 ===== Global Configuration 204 In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or `/etc/trac/trac.ini`, depending on the distribution. You may want to specify that file to inherit from when upgrading. Literally, when upgrading you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location. 205 206 === 7. Restart the Web Server #RestarttheWebServer 145 === 7. Restart the Web Server === #RestarttheWebServer 207 146 208 147 If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. 209 148 210 == Known Issues 149 == Known Issues == 150 151 Things you should pay attention to, while upgrading. 211 152 212 153 === Customized Templates 213 154 214 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.155 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 wary 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 ;-) 215 156 216 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 [trac:TracDev/ApiChanges]pages.157 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. 217 158 218 === !ZipImportError 159 === !ZipImportError === 219 160 220 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.161 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. 221 162 See [trac:#7014] for details. 222 163 223 === Wiki Upgrade 164 === Wiki Upgrade === 224 165 `trac-admin` will not delete or remove default wiki pages that were present in a previous version but are no longer in the new version. 225 166 226 === Trac database upgrade 167 === Trac database upgrade === 227 168 228 A known issue in some versions of [trac: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].169 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]. 229 170 230 === Parent dir231 If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children willwork.171 === parent dir === 172 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work. 232 173 233 174 == Related topics 234 175 235 === Upgrading Python 176 === Upgrading Python === 236 177 237 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.178 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. 238 179 239 ==== Windows and Python 2.6 180 ==== Windows and Python 2.6 ==== 240 181 241 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 [trac:TracSubversion]. That package works withouttweaking.182 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). The good news is, that works with no tweaking. 242 183 243 === Changing Database Backend 184 === Changing Database Backend === 185 ==== SQLite to PostgreSQL ==== 244 186 245 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.187 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 246 188 247 === Upgrading from older versions of Trac #OlderVersions189 === Upgrading from older versions of Trac === #OlderVersions 248 190 249 191 For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
