Changes between Version 8 and Version 9 of 1.1/TracUpgrade
- Timestamp:
- Mar 10, 2015, 12:26:38 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
1.1/TracUpgrade
v8 v9 1 = Upgrade Instructions =1 = Upgrade Instructions 2 2 [[TracGuideToc]] 3 3 [[TranslatedPages]] 4 4 [[PageOutline(2-4,,inline,unnumbered)]] 5 5 6 == Instructions ==6 == Instructions 7 7 8 8 Typically, there are seven steps involved in upgrading to a newer version of Trac: … … 10 10 === 1. Bring your server off-line 11 11 12 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]. 13 14 === 2. Update the Trac Code === #UpdatetheTracCode 12 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]. 13 14 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. 15 16 === 2. Update the Trac Code #UpdatetheTracCode 15 17 16 18 Get the new version as described in TracInstall, or your operating system specific procedure. … … 18 20 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: 19 21 20 {{{ 21 #easy_install --upgrade Trac==1.022 {{{#!sh 23 easy_install --upgrade Trac==1.0 22 24 }}} 23 25 … … 32 34 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. 33 35 34 === 3. Upgrade the Trac Environment ===#UpgradetheTracEnvironment36 === 3. Upgrade the Trac Environment #UpgradetheTracEnvironment 35 37 36 38 Environment upgrades are not necessary for minor version releases unless otherwise noted. 37 39 38 40 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]: 39 {{{ 41 {{{#!sh 40 42 trac-admin /path/to/projenv upgrade 41 43 }}} … … 45 47 Note that a backup of your database will be performed automatically prior to the upgrade. 46 48 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: 47 {{{ 49 {{{#!sh 48 50 trac-admin /path/to/projenv upgrade --no-backup 49 51 }}} … … 52 54 53 55 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: 54 {{{ 56 {{{#!sh 55 57 trac-admin /path/to/projenv wiki upgrade 56 58 }}} … … 58 60 Note that this procedure will leave your `WikiStart` page intact. 59 61 60 === 5. Refresh static resources ===62 === 5. Refresh static resources 61 63 62 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: 63 {{{ 65 {{{#!sh 64 66 trac-admin /path/to/env deploy /deploy/path 65 67 }}} … … 71 73 }}} 72 74 73 === 6. Steps specific to a given Trac version ===74 75 ==== Upgrading from Trac 1.0 to 1.1.x ====#to1.1.x76 77 ===== Python 2.5 no longer supported =====75 === 6. Steps specific to a given Trac version 76 77 ==== Upgrading from Trac 1.0 to 1.1.x #to1.1.x 78 79 ===== Python 2.5 no longer supported 78 80 The minimum supported version of python is now 2.6 79 81 80 82 ===== New permissions policy for read-only wiki pages 81 83 Since 1.1.2 the read-only attribute of wiki pages is enabled and enforced only when `ReadonlyWikiPolicy` is in the list of active permission policies. If `[trac] permission_policy` has the default value `DefaultPermissionPolicy, LegacyAttachmentPolicy`, then `ReadonlyWikiPolicy` should be automatically appended to the list when upgrading the environment: 82 {{{ 84 {{{#!ini 83 85 [trac] 84 86 permission_policies = ReadonlyWikiPolicy, … … 88 90 If other permission policies are enabled, //trac.ini// will need to be edited to append `ReadonlyWikiPolicy` to the list of active `permission_policies`. See TracFineGrainedPermissions#ReadonlyWikiPolicy for additional details on the proper ordering. 89 91 90 ==== Upgrading from Trac 0.12 to Trac 1.0 ====#to1.091 92 ===== Python 2.4 no longer supported =====92 ==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0 93 94 ===== Python 2.4 no longer supported 93 95 Upgrade Python to at least 2.5, but not 3.0. 94 96 95 97 ===== Subversion components not enabled by default for new installations 96 98 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: 97 {{{ 99 {{{#!ini 98 100 [components] 99 101 tracopt.versioncontrol.svn.* = enabled … … 107 109 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. 108 110 109 ==== Upgrading from Trac 0.11 to Trac 0.12 ====110 111 ===== Python 2.3 no longer supported =====111 ==== Upgrading from Trac 0.11 to Trac 0.12 112 113 ===== Python 2.3 no longer supported 112 114 The minimum supported version of Python is now 2.4. 113 115 114 ===== SQLite v3.x required =====116 ===== SQLite v3.x required 115 117 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. 116 118 117 ===== [trac:PySqlite] 2 required =====119 ===== [trac:PySqlite] 2 required 118 120 [trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below. 119 121 120 ===== Multiple Repository Support =====122 ===== Multiple Repository Support 121 123 The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. 122 124 123 125 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. 124 126 125 ===== Resynchronize the Trac Environment Against the Source Code Repository =====127 ===== Resynchronize the Trac Environment Against the Source Code Repository 126 128 127 129 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: 128 130 129 {{{ 131 {{{#!sh 130 132 trac-admin /path/to/projenv repository resync '*' 131 133 }}} 132 134 133 ===== Improved repository synchronization =====135 ===== Improved repository synchronization 134 136 In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. 135 137 … … 138 140 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. 139 141 140 ===== Authz permission checking =====142 ===== Authz permission checking 141 143 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. 142 144 143 ===== Microsecond timestamps =====145 ===== Microsecond timestamps 144 146 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. 145 147 146 ==== Upgrading from Trac 0.10 to Trac 0.11 ====147 ===== Site Templates and Styles =====148 ==== Upgrading from Trac 0.10 to Trac 0.11 149 ===== Site Templates and Styles 148 150 The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. 149 151 150 152 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. 151 153 152 ===== Trac Macros, Plugins =====154 ===== Trac Macros, Plugins 153 155 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. 154 156 155 ===== For FCGI/WSGI/CGI users =====157 ===== For FCGI/WSGI/CGI users 156 158 For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: 157 {{{ 159 {{{#!sh 158 160 trac-admin /path/to/env deploy /deploy/directory/path 159 161 }}} … … 161 163 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. 162 164 163 ===== Web Admin plugin integrated =====165 ===== Web Admin plugin integrated 164 166 If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11. 165 167 … … 190 192 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. 191 193 192 === 7. Restart the Web Server ===#RestarttheWebServer194 === 7. Restart the Web Server #RestarttheWebServer 193 195 194 196 If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. 195 197 196 == Known Issues ==198 == Known Issues 197 199 198 200 === Customized Templates … … 202 204 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. 203 205 204 === !ZipImportError ===206 === !ZipImportError 205 207 206 208 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. 207 209 See [trac:#7014] for details. 208 210 209 === Wiki Upgrade ===211 === Wiki Upgrade 210 212 `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. 211 213 212 === Trac database upgrade ===214 === Trac database upgrade 213 215 214 216 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]. 215 217 216 === Parent dir ===218 === Parent dir 217 219 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. 218 220 219 221 == Related topics 220 222 221 === Upgrading Python ===223 === Upgrading Python 222 224 223 225 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. 224 226 225 ==== Windows and Python 2.6 ====227 ==== Windows and Python 2.6 226 228 227 229 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 without tweaking. 228 230 229 === Changing Database Backend ===231 === Changing Database Backend 230 232 231 233 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. 232 234 233 === Upgrading from older versions of Trac ===#OlderVersions235 === Upgrading from older versions of Trac #OlderVersions 234 236 235 237 For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
