Changes between Version 3 and Version 4 of TracUpgrade
- Timestamp:
- Nov 17, 2014, 9:39:05 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracUpgrade
v3 v4 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 … … 28 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. 29 34 30 === 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment35 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment 31 36 32 37 Environment upgrades are not necessary for minor version releases unless otherwise noted. … … 45 50 }}} 46 51 47 === 3. Update the Trac Documentation === #UpdatetheTracDocumentation52 === 4. Update the Trac Documentation === #UpdatetheTracDocumentation 48 53 49 54 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: … … 54 59 Note that this procedure will leave your `WikiStart` page intact. 55 60 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 61 64 62 === 5. Refresh static resources === … … 70 68 this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`. 71 69 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. 70 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. 71 {{{#!comment 72 Remove above note once #9936 is fixed. 73 }}} 73 74 74 75 === 6. Steps specific to a given Trac version === 76 77 ==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0 78 79 ===== Python 2.4 no longer supported ===== 80 The minimum supported version of python is now 2.5 81 82 ===== Subversion components not enabled by default for new installations 83 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: 84 {{{ 85 [components] 86 tracopt.versioncontrol.svn.* = enabled 87 }}} 88 The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled. 89 90 91 ===== Attachments migrated to new location 92 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. 93 94 ===== Behavior of `[ticket] default_owner` changed 95 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. 96 97 75 98 ==== Upgrading from Trac 0.11 to Trac 0.12 ==== 99 76 100 ===== Python 2.3 no longer supported ===== 77 101 The minimum supported version of python is now 2.4 … … 88 112 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. 89 113 114 ===== Resynchronize the Trac Environment Against the Source Code Repository ===== 115 116 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: 117 118 {{{ 119 trac-admin /path/to/projenv repository resync '*' 120 }}} 121 90 122 ===== Improved repository synchronization ===== 91 123 In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. … … 93 125 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 126 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.127 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 128 97 129 ===== Authz permission checking ===== … … 127 159 == Known Issues == 128 160 161 Things you should pay attention to, while upgrading. 162 163 === Customized Templates 164 165 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 ;-) 166 167 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. 168 169 === !ZipImportError === 170 171 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. 172 See [trac:#7014] for details. 173 174 === Wiki Upgrade === 175 `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. 176 177 === Trac database upgrade === 178 179 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]. 180 129 181 === parent dir === 130 182 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work. 131 183 132 === Wiki Upgrade === 133 `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. 134 135 === Trac database upgrade === 136 137 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 139 == Upgrading Python == 184 == Related topics 185 186 === Upgrading Python === 140 187 141 188 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 189 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 == 190 ==== Windows and Python 2.6 ==== 191 192 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. 193 194 === Changing Database Backend === 195 196 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. 197 198 === Upgrading from older versions of Trac === #OlderVersions 153 199 154 200 For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
