Changes between Version 4 and Version 5 of TracUpgrade

Mar 20, 2010, 2:22:34 PM (12 years ago)



  • TracUpgrade

    v4 v5  
    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.
    6 Environment upgrades are not necessary for minor version releases unless otherwise noted.
    84== Instructions ==
    10 Typically, there are four steps involved in upgrading to a newer version of Trac:
     6Typically, there are five steps involved in upgrading to a newer version of Trac:
    12 === Update the Trac Code ===
     8=== 1. Update the Trac Code === #UpdatetheTracCode
    1410Get the new version as described in TracInstall, or your operating system specific procedure.
     12If you installed a recent 0.11 version of Trac via {{{easy_install}}}, it might be the easiest to use it also to upgrade you Trac installation.
     15# easy_install --upgrade Trac
    1618If 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]).
    1820You 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.
    1921The 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
     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
    2426You 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).
    2830If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    30 === Upgrade the Trac Environment ===
     32=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     34Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3236After 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]:
    3741This command will do nothing if the environment is already up-to-date.
    39 Note 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:
     43Note that a backup of your database will be performed automatically prior to the upgrade.
     44This feature is relatively new for the PostgreSQL or MySQL database backends, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:
    4146trac-admin /path/to/projenv upgrade --no-backup
    4449If 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.
    46 === Update the Trac Documentation ===
     51=== 3. Update the Trac Documentation === #UpdatetheTracDocumentation
    4853Every [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, [TracAdmin trac-admin] provides a command to upgrade the documentation:
    5358Note that this procedure will of course leave your `WikiStart` page intact.
    55 === Site Templates ===
     60=== 4. Resynchronize the Trac Environment Against the Source Code Repository ===
     62Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[ No changeset ??? in the repository]" while browsing the source through the Trac interface:
     65trac-admin /path/to/projenv resync
     68=== 5. Steps specific to a given Trac version  ===
     69==== Upgrading to Trac 0.12 ====
     70SQLite v2.x is no longer supported, if you happen to still use a Trac database using this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details.
     72If you plan to add more repositories to your Trac instance, as this is now possible with the newly introduced multiple repository support, please refer to TracRepositoryAdmin#Migration.
     74This can be of interest even if you only have one repository, as there's now a way to avoid the potentially costly resync check at every request.
     76==== Upgrading to Trac 0.11 ====
     77===== Site Templates =====
    5678The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information.
    58 === Trac Macros, Plugins ===
     80===== Trac Macros, Plugins =====
    5981The 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.
    61 === For CGI users ===
    63 For those who run Trac under the CGI environment, run this command in order to obtain the trac.cgi file:
     83===== For FCGI/WSGI/CGI users =====
     84For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    6586trac-admin /path/to/env deploy /deploy/directory/path
    6889This 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.
    70 === Restart the Web Server ===
     91=== 6. Restart the Web Server === #RestarttheWebServer
    7193If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    7395== Known Issues ==
    7497=== parent dir ===
    7598If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
    76100=== some core modules won't load ===
    77101This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
    82106Remove the `Lib/site-packages/trac` folder and reinstall.
    83108=== 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.
     109`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.
    86112== Changing Database Backend ==
    87 == SQLite to PostgreSQL ==
     113=== SQLite to PostgreSQL ===
    89115The [ sqlite2pg] script on [] has been written to assist in migrating a SQLite database to a PostgreSQL database