| 3 | | |
| 4 | | A [TracEnvironment Trac environment] needs to be upgraded before it can be used with Trac 0.11. This document describes the steps necessary to upgrade an environment. |
| | 3 | [[PageOutline(2-4,,inline,unnumbered)]] |
| | 4 | |
| | 5 | == Instructions == |
| | 6 | |
| | 7 | Typically, there are seven steps involved in upgrading to a newer version of Trac: |
| | 8 | |
| | 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 |
| | 14 | |
| | 15 | Get the new version as described in TracInstall, or your operating system specific procedure. |
| | 16 | |
| | 17 | 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 |
| | 21 | }}} |
| | 22 | |
| | 23 | If you do a manual (not operating system-specific) upgrade, you should also stop any running Trac servers before the installation. Doing "hot" upgrades is not advised, especially on Windows ([trac:#7265]). |
| | 24 | |
| | 25 | You may also want to remove the pre-existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory, or remove Trac `.egg` files from former versions. |
| | 26 | The location of the site-packages directory depends on the operating system and the location in which Python was installed. However, the following locations are typical: |
| | 27 | * on Linux: `/usr/lib/python2.X/site-packages` |
| | 28 | * on Windows: `C:\Python2.X\lib\site-packages` |
| | 29 | * on MacOSX: `/Library/Python/2.X/site-packages` |
| | 30 | |
| | 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.) |
| | 32 | |
| | 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 |
| 8 | | == Instructions == |
| 9 | | |
| 10 | | Typically, there are four steps involved in upgrading to a newer version of Trac: |
| 11 | | |
| 12 | | === Update the Trac Code === |
| 13 | | |
| 14 | | Get the new version as described in TracInstall, or your operating system specific procedure. |
| 15 | | |
| 16 | | If you do a manual (not operating system specific) upgrade, you should also stop any running Trac server before the installation. Doing "hot" upgrades is not advised, especially not on Windows ([trac:ticket:7625 #7265]). |
| 17 | | |
| 18 | | You may also want to remove the pre-existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory, or remove Trac .eggs from former versions. |
| 19 | | The location of the site-packages directory depends on the operating system, and the location in which Python was installed. However, the following locations are common: |
| 20 | | * If you’re using Linux: /usr/lib/python2.X/site-packages |
| 21 | | * If you’re using Windows: C:\Python2.X\lib\site-packages |
| 22 | | * If you’re using MacOSX: /Library/Python/2.X/site-packages |
| 23 | | |
| 24 | | 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). |
| 25 | | |
| 26 | | This cleanup is not mandatory, but it 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. |
| 27 | | |
| 28 | | If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base. |
| 29 | | |
| 30 | | === Upgrade the Trac Environment === |
| 31 | | |
| 53 | | Note that this procedure will of course leave your `WikiStart` page intact. |
| 54 | | |
| 55 | | === Site Templates === |
| 56 | | The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information. |
| 57 | | |
| 58 | | === Trac Macros, Plugins === |
| 59 | | 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 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. |
| 60 | | |
| 61 | | === For CGI users === |
| 62 | | |
| 63 | | For those who run Trac under the CGI environment, run this command in order to obtain the trac.cgi file: |
| | 59 | Note that this procedure will leave your `WikiStart` page intact. |
| | 60 | |
| | 61 | |
| | 62 | === 5. Refresh static resources === |
| | 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: |
| | 65 | {{{ |
| | 66 | trac-admin /path/to/env deploy /deploy/path |
| | 67 | }}} |
| | 68 | this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`. |
| | 69 | |
| | 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 | }}} |
| | 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 | |
| | 98 | ==== Upgrading from Trac 0.11 to Trac 0.12 ==== |
| | 99 | |
| | 100 | ===== Python 2.3 no longer supported ===== |
| | 101 | The minimum supported version of python is now 2.4 |
| | 102 | |
| | 103 | ===== SQLite v3.x required ===== |
| | 104 | 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. |
| | 105 | |
| | 106 | ===== PySqlite 2 required ===== |
| | 107 | PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below). |
| | 108 | |
| | 109 | ===== Multiple Repository Support ===== |
| | 110 | The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. |
| | 111 | |
| | 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. |
| | 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 | |
| | 122 | ===== Improved repository synchronization ===== |
| | 123 | In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. |
| | 124 | |
| | 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. |
| | 126 | |
| | 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. |
| | 128 | |
| | 129 | ===== Authz permission checking ===== |
| | 130 | 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). |
| | 131 | |
| | 132 | ===== Microsecond timestamps ===== |
| | 133 | 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. |
| | 134 | |
| | 135 | ==== Upgrading from Trac 0.10 to Trac 0.11 ==== |
| | 136 | ===== Site Templates and Styles ===== |
| | 137 | The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. |
| | 138 | |
| | 139 | 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. |
| | 140 | |
| | 141 | ===== Trac Macros, Plugins ===== |
| | 142 | 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. |
| | 143 | |
| | 144 | ===== For FCGI/WSGI/CGI users ===== |
| | 145 | For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: |
| 76 | | === some core modules won't load === |
| 77 | | This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first. |
| 78 | | Some modules were previously capitalized and were changed to lower case, e.g. trac/About.py became trac/about.py. You may find such messages in the Trac log: |
| 79 | | {{{ |
| 80 | | ERROR: Skipping "trac.about = trac.about": (can't import "No module named about") |
| 81 | | }}} |
| 82 | | Remove the `Lib/site-packages/trac` folder and reinstall. |
| 83 | | === Wiki Upgrade === |
| 84 | | `trac-admin` will not delete or remove pages that were in version 0.10 but now are not in version 0.11, such as WikiMacros. |
| 85 | | |
| 86 | | == Changing Database Backend == |
| 87 | | == SQLite to PostgreSQL == |
| 88 | | |
| 89 | | 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 |
| 90 | | |
| 91 | | == Older Versions == |
| 92 | | |
| 93 | | For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade. |
| 94 | | |
| 95 | | Note that downgrading from Trac 0.11 to Trac 0.10.4 or 0.10.5 is easy, but has to be done manually, e.g. |
| 96 | | {{{ |
| 97 | | $ sqlite3 db/trac.db "update system set value=20 where name='database_version'" |
| 98 | | }}} |
| 99 | | (upgrade can be redone the normal way later on) |
| | 183 | |
| | 184 | == Related topics |
| | 185 | |
| | 186 | === Upgrading Python === |
| | 187 | |
| | 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. |
| | 189 | |
| | 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 |
| | 199 | |
| | 200 | For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions]. |
