| 25 | | === Upgrade the Trac Environment === |
| | 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 |
| 27 | | Unless noted otherwise, upgrading between major versions (such as 0.8 and 0.9) involves changes to the database schema, and possibly the layout of the [wiki:TracEnvironment environment directory]. Fortunately, Trac provides automated upgrade scripts to ease the pain. These scripts are run via [wiki:TracAdmin trac-admin]: |
| | 26 | 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). |
| | 27 | |
| | 28 | 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. |
| | 29 | |
| | 30 | If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base. |
| | 31 | |
| | 32 | === 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment |
| | 33 | |
| | 34 | Environment upgrades are not necessary for minor version releases unless otherwise noted. |
| | 35 | |
| | 36 | 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]: |
| 50 | | In order to reload the new Trac code you will need to restart your web server (note this is not necessary for [wiki:TracCgi CGI]). |
| 51 | | |
| 52 | | == Specific Versions == |
| 53 | | |
| 54 | | The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac. |
| 55 | | |
| 56 | | == From 0.9.x to 0.10.x == |
| 57 | | |
| 58 | | Due to some changes in the Wiki syntax, you may notice that certain parts of your pages no longer work as expected: |
| 59 | | * Previously, links to images would result in that image being embedded into the page. Since 0.10, links to images remain plain links. If you want to embed an image in the page, use the `[[Image]]` macro. |
| 60 | | * You can no longer use `%20` in wiki links to encode spaces. Instead, you should quote the name containing spaces (for example, use `wiki:"My page"` instead of `wiki:My%20page`.) |
| 61 | | |
| 62 | | Several enhancements have been made to the version control subsystem, in particular for the support of scoped repositories has been improved. |
| 63 | | It is recommended that you perform a [TracAdmin#InteractiveMode trac-admin] '''`resync`''' operation to take advantage of these improvements. |
| 64 | | |
| 65 | | Also note that the argument list of the [TracAdmin trac-admin] '''`initenv`''' command has changed: there's a new argument for determining the type of version control system. The old usage was: |
| 66 | | {{{ |
| 67 | | initenv <projectname> <db> <repospath> <templatepath> |
| 68 | | }}} |
| 69 | | The new usage is: |
| 70 | | {{{ |
| 71 | | initenv <projectname> <db> <repostype> <repospath> <templatepath> |
| 72 | | }}} |
| 73 | | If you're using any scripts that automate the creation of Trac environments, you will need to update them. If you're using Subversion, specify `svn` for the `<repostype>` argument. |
| 74 | | |
| 75 | | == From 0.9.3 to 0.9.4 == |
| 76 | | |
| 77 | | There is a bug in Pysqlite 1.x that causes reports using the "%" character for `LIKE` clauses or date formatting to fail. You will need to use escape the percent characters with another: "%%". |
| 78 | | |
| 79 | | == From 0.9.x to 0.9.3 or later == |
| 80 | | |
| 81 | | If you are using plugins you might need to upgrade them. See http://projects.edgewall.com/trac/milestone/0.9.3 for further details. |
| 82 | | |
| 83 | | == From 0.9-beta to 0.9 == |
| 84 | | |
| 85 | | If inclusion of the static resources (style sheets, javascript, images) is not working, check the value of the `htdocs_location` in trac.ini. For [wiki:TracModPython mod_python], [wiki:TracStandalone Tracd] and [wiki:TracFastCgi FastCGI], you can simply remove the option altogether. For [wiki:TracCgi CGI], you should fix it to point to the URL you mapped the Trac `htdocs` directory to (although you can also remove it and then [wiki:TracCgi#MappingStaticResources map the static resources]). If you're still having problems after removing the option, check the paths in the `trac/siteconfig.py` file and fix them if they're incorrect. |
| 86 | | |
| 87 | | If you've been using plugins with a beta release of Trac 0.9, or have disabled some of the built-in components, you might have to update the rules for disabling/enabling components in [wiki:TracIni trac.ini]. In particular, globally installed plugins now need to be enabled explicitly. See TracPlugins and TracIni for more information. |
| 88 | | |
| 89 | | If you want to enable the display of all ticket changes in the timeline (the “Ticket Details” option), you now have to explicitly enable that in [wiki:TracIni trac.ini], too: |
| | 62 | 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: |
| 98 | | [wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration: |
| | 73 | ===== Trac Macros, Plugins ===== |
| | 74 | 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. |
| | 75 | |
| | 76 | ===== For FCGI/WSGI/CGI users ===== |
| | 77 | For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: |
| 106 | | To do this, you need to have both SQLite 2.8.x and SQLite 3.x installed (they have different filenames so can coexist on the same system). Then use the following commands: |
| | 84 | === 6. Restart the Web Server === #RestarttheWebServer |
| | 85 | |
| | 86 | If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. |
| | 87 | |
| | 88 | == Known Issues == |
| | 89 | |
| | 90 | === parent dir === |
| | 91 | If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work. |
| | 92 | |
| | 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: |
| 112 | | To update multiple database files at once on linux you may use the following command (replace {{{/var/trac}}} withe the location where your trac installtions reside): |
| | 101 | === Wiki Upgrade === |
| | 102 | `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. |
| | 103 | |
| | 104 | |
| | 105 | == Changing Database Backend == |
| | 106 | === SQLite to PostgreSQL === |
| | 107 | |
| | 108 | 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 |
| | 109 | |
| | 110 | == Older Versions == |
| | 111 | |
| | 112 | For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade. |
| | 113 | |
| | 114 | 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. |
| 116 | | |
| 117 | | Remember the give the webserver write permission to trac.db. |
| 118 | | |
| 119 | | After testing that the conversion was successful, the `trac2.db` file can be deleted. For more information on the SQLite upgrade see http://www.sqlite.org/version3.html. |
| 120 | | |
| 121 | | == From 0.7.x to 0.8 == |
| 122 | | |
| 123 | | 0.8 adds a new roadmap feature which requires additional permissions. While a |
| 124 | | fresh installation will by default grant ROADMAP_VIEW and MILESTONE_VIEW |
| 125 | | permissions to anonymous, these permissions have to be granted manually when |
| 126 | | upgrading: |
| 127 | | {{{ |
| 128 | | $ trac-admin /path/to/projectenv permission add anonymous MILESTONE_VIEW |
| 129 | | $ trac-admin /path/to/projectenv permission add anonymous ROADMAP_VIEW |
| 130 | | }}} |
| | 118 | (upgrade can be redone the normal way later on) |
