Changes between Version 4 and Version 5 of TracUpgrade


Ignore:
Timestamp:
Nov 13, 2011, 3:47:30 AM (13 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v4 v5  
    22[[TracGuideToc]]
    33
    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.
    5 
    6 Environment upgrades are not necessary for minor version releases unless otherwise noted.
    7 
    8 
    94== Instructions ==
    105
    11 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:
    127
    13 === Update the Trac Code ===
     8=== 1. Update the Trac Code === #UpdatetheTracCode
    149
    1510Get the new version as described in TracInstall, or your operating system specific procedure.
    1611
    17 If you do a manual (not operating system specific) upgrade, you may also later on want to remove the existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory.
     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.
    1813
     14{{{
     15# easy_install --upgrade Trac
     16}}}
     17
     18If 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]).
     19
     20You 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/Python2.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
    2325
    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).
    2527
    26 > If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
     28This 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.
    2729
     30If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    2831
    29 === Upgrade the Trac Environment ===
     32=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     33
     34Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3035
    3136After 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]:
    … …  
    3641This command will do nothing if the environment is already up-to-date.
    3742
    38 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:
    3945{{{
    4046trac-admin /path/to/projenv upgrade --no-backup
    4147}}}
    4248
    43 === Update the Trac Documentation ===
     49If 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.
     50
     51=== 3. Update the Trac Documentation === #UpdatetheTracDocumentation
    4452
    4553Every [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:
    … …  
    5058Note that this procedure will of course leave your `WikiStart` page intact.
    5159
    52 === Trac Macros, Plugins ===
    53 The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of ClearSilver and the HDF); they need to be converted to the new-style macros, see TracWikiMacros.
     60=== 4. Resynchronize the Trac Environment Against the Source Code Repository ===
    5461
     62Each [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:
    5563
    56 === Restart the Web Server ===
     64{{{
     65trac-admin /path/to/projenv resync
     66}}}
     67
     68=== 5. Steps specific to a given Trac version  ===
     69==== Upgrading to Trac 0.11 ====
     70===== Site Templates =====
     71The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information.
     72
     73===== Trac Macros, Plugins =====
     74The 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 =====
     77For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
     78{{{
     79trac-admin /path/to/env deploy /deploy/directory/path
     80}}}
     81
     82This 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.
     83
     84=== 6. Restart the Web Server === #RestarttheWebServer
     85
    5786If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    5887
    5988== Known Issues ==
     89
    6090=== parent dir ===
    6191If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
     92
    6293=== some core modules won't load ===
    6394This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
    … …  
    6899Remove the `Lib/site-packages/trac` folder and reinstall.
    69100
     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
    70105== Changing Database Backend ==
    71 == SQLite to PostgreSQL ==
     106=== SQLite to PostgreSQL ===
    72107
    73108The [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
    … …  
    75110== Older Versions ==
    76111
    77 For upgrades from former versions refer to wiki:0.10/TracUpgrade.
     112For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade.
     113
     114Note 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.
     115{{{
     116$ sqlite3 db/trac.db "update system set value=20 where name='database_version'"
     117}}}
     118(upgrade can be redone the normal way later on)
    78119
    79120-----