Changes between Version 1 and Version 2 of TracUpgrade

Apr 7, 2008, 11:15:27 AM (9 years ago)



  • TracUpgrade

    v1 v2  
    4 Trac environments sometimes need to be upgraded before they can be used
    5 in a new version of Trac. This document describes the steps necessary
    6 to upgrade an environment.
     4A Trac environment sometimes needs to be upgraded before it can be used with a new version of Trac. This document describes the steps necessary to upgrade an environment.
     6 '''Note''': ''Environment upgrades are not necessary for minor version releases unless otherwise noted. For example, there's no need to upgrade a Trac environment created with (or upgraded) 0.8.0 when installing 0.8.4 (or any other 0.8.x release).''
     8== General Instructions ==
     10Typically, there are four steps involved in upgrading to a newer version of Trac:
     12=== Update the Trac Code ===
     14Get the new version of Trac, either by downloading an offical release package or by checking it out from the [ Subversion repository].
     16If you're doing a major version upgrade (such as from 0.8 to 0.9), it is ''highly'' recommended that you first remove the existing Trac code. To do this, you need to delete the `trac` directory from the Python `lib/site-packages` directory. 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).
     18If you have a source distribution, you need to run
     20python install
     23to install the new version. If you've downloaded the Windows installer, you execute it, and so on.
     25=== Upgrade the Trac Environment ===
     27Unless 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]:
     29trac-admin /path/to/projenv upgrade
     32This command will do nothing if the environment is already up-to-date.
     34Note that if you are using a PostgreSQL database, this command will fail with the message that the environment can only be backed up when you use an SQLite database. This means that you will have to backup the repository and the database manually. Then, to perform the actual upgrade, run:
     36trac-admin /path/to/projenv upgrade --no-backup
     39=== Update the Trac Documentation ===
     41Every [wiki: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, [wiki:TracAdmin trac-admin] provides a command to upgrade the documentation:
     43trac-admin /path/to/projenv wiki upgrade
     46Note that this procedure will of course leave your `WikiStart` page intact.
     48=== Restart the Web Server ===
     50In order to reload the new Trac code you will need to restart your web server (note this is not necessary for [wiki:TracCgi CGI]).
     52== Specific Versions ==
     54The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac.
     56== From 0.9.x to 0.10.x ==
     58Due 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`.)
     62Several enhancements have been made to the version control subsystem, in particular for the support of scoped repositories has been improved.
     63It is recommended that you perform a [TracAdmin#InteractiveMode trac-admin] '''`resync`''' operation to take advantage of these improvements.
     65Also 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:
     67   initenv <projectname> <db> <repospath> <templatepath>
     69The new usage is:
     71   initenv <projectname> <db> <repostype> <repospath> <templatepath>
     73If 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.
     75== From 0.9.3 to 0.9.4 ==
     77There 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: "%%".
     79== From 0.9.x to 0.9.3 or later ==
     81If you are using plugins you might need to upgrade them. See for further details.
     83== From 0.9-beta to 0.9 ==
     85If 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/` file and fix them if they're incorrect.
     87If 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.
     89If 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:
     93ticket_show_details = true
     96== From 0.8.x to 0.9 ==
     98[wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration:
     100   from: PythonHandler trac.ModPythonHandler
     101   to:   PythonHandler trac.web.modpython_frontend
     104If you have [ PySQLite] 2.x installed, Trac will now try to open your SQLite database using the SQLite 3.x file format. The database formats used by SQLite 2.8.x and SQLite 3.x are incompatible. If you get an error like ''“file is encrypted or is not a database”'' after upgrading, then you must convert your database file.
     106To 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:
     108 $ mv trac.db trac2.db
     109 $ sqlite trac2.db .dump | sqlite3 trac.db
     112To 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):
     114 $ find /var/trac/ -iname "trac.db" | xargs -i bash -c "mv {} {}.2; sqlite {}.2 .dump | sqlite3 {};"
     117Remember the give the webserver write permission to trac.db.
     119After testing that the conversion was successful, the `trac2.db` file can be deleted. For more information on the SQLite upgrade see
    8121== From 0.7.x to 0.8 ==
    10 The database schema was changed between 0.7.x and 0.8. Existing environments
    11 must be upgraded before they can be used with Trac 0.8.
    13 The following command will automatically perform the upgrade:
    14 {{{
    15  $ trac-admin /path/to/projectenv upgrade
    16 }}}
    18 Trac environments are created with a default set of wiki pages. It's
    19 recommended to update these pages on existing environments whenever
    20 Trac is upgraded to get up-to-date documentation and additional functionality.
    21 The following command will perform the update:
    22 {{{
    23  $ trac-admin /path/to/projectenv wiki upgrade
    24 }}}
    261230.8 adds a new roadmap feature which requires additional permissions. While a