| 20 | | 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. |
| 21 | | 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: |
| 22 | | * on Linux: /usr/lib/python2.X/site-packages |
| 23 | | * on Windows: C:\Python2.X\lib\site-packages |
| 24 | | * on MacOSX: /Library/Python/2.X/site-packages |
| | 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` |
| 60 | | === 4. Resynchronize the Trac Environment Against the Source Code Repository === |
| | 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 | ==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0 |
| | 77 | |
| | 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: |
| | 79 | {{{ |
| | 80 | [components] |
| | 81 | tracopt.versioncontrol.svn.* = enabled |
| | 82 | }}} |
| | 83 | The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled. |
| | 84 | |
| | 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. |
| | 86 | |
| | 87 | |
| | 88 | ==== Upgrading from Trac 0.11 to Trac 0.12 ==== |
| | 89 | |
| | 90 | ===== Python 2.3 no longer supported ===== |
| | 91 | The minimum supported version of python is now 2.4 |
| | 92 | |
| | 93 | ===== SQLite v3.x required ===== |
| | 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. |
| | 95 | |
| | 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). |
| | 98 | |
| | 99 | ===== Multiple Repository Support ===== |
| | 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. |
| | 101 | |
| | 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. |
| | 103 | |
| | 104 | ===== Resynchronize the Trac Environment Against the Source Code Repository ===== |
| 68 | | === 5. Steps specific to a given Trac version === |
| 69 | | ==== Upgrading to Trac 0.11 ==== |
| 70 | | ===== Site Templates ===== |
| 71 | | The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information. |
| | 112 | ===== Improved repository synchronization ===== |
| | 113 | In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. |
| | 114 | |
| | 115 | 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. |
| | 116 | |
| | 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, 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. |
| | 118 | |
| | 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). |
| | 121 | |
| | 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. |
| | 124 | |
| | 125 | ==== Upgrading from Trac 0.10 to Trac 0.11 ==== |
| | 126 | ===== Site Templates and Styles ===== |
| | 127 | The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. |
| | 128 | |
| | 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. |
| 93 | | === some core modules won't load === |
| 94 | | This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first. |
| 95 | | 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: |
| 96 | | {{{ |
| 97 | | ERROR: Skipping "trac.about = trac.about": (can't import "No module named about") |
| 98 | | }}} |
| 99 | | Remove the `Lib/site-packages/trac` folder and reinstall. |
| | 153 | === Customized Templates |
| | 154 | |
| | 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 ;-) |
| | 156 | |
| | 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. |
| | 158 | |
| | 159 | === !ZipImportError === |
| | 160 | |
| | 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. |
| | 162 | See [trac:#7014] for details. |
| 105 | | == Changing Database Backend == |
| 106 | | === SQLite to PostgreSQL === |
| | 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]. |
| | 170 | |
| | 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. |
| | 173 | |
| | 174 | == Related topics |
| | 175 | |
| | 176 | === Upgrading Python === |
| | 177 | |
| | 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. |
| | 179 | |
| | 180 | ==== Windows and Python 2.6 ==== |
| | 181 | |
| | 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. |
| | 183 | |
| | 184 | === Changing Database Backend === |
| | 185 | ==== SQLite to PostgreSQL ==== |
