Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
Jul 4, 2010, 6:44:42 AM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v1 v2  
    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 seven 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 already have a 0.11 version of Trac installed via `easy_install`, it might be the easiest to use it also to upgrade you Trac installation.
    1813
     14{{{
     15# easy_install --upgrade Trac==0.12b1
     16}}}
     17(once beta1 is released, that is)
     18
     19If 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]).
     20
     21You 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.
    1922The 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
     23 * on Linux: `/usr/lib/python2.X/site-packages`
     24 * on Windows: `C:\Python2.X\lib\site-packages`
     25 * on MacOSX: `/Library/Python/2.X/site-packages`
    2326
    2427You 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).
    2528
    26 > If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
     29This 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.
    2730
     31=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
    2832
    29 === Upgrade the Trac Environment ===
     33Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3034
    3135After 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]:
    … …  
    3640This command will do nothing if the environment is already up-to-date.
    3741
    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:
     42Note that a backup of your database will be performed automatically prior to the upgrade.
     43This 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:
    3944{{{
    4045trac-admin /path/to/projenv upgrade --no-backup
    4146}}}
    4247
    43 === Update the Trac Documentation ===
     48=== 3. Update the Trac Documentation === #UpdatetheTracDocumentation
    4449
    4550Every [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:
    … …  
    5055Note that this procedure will of course leave your `WikiStart` page intact.
    5156
    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.
     57=== 4. Resynchronize the Trac Environment Against the Source Code Repository ===
    5458
     59Each [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:
    5560
    56 === Restart the Web Server ===
     61{{{
     62trac-admin /path/to/projenv repository resync '*'
     63}}}
     64
     65=== 5. Refresh static resources ===
     66
     67If you've setup web server to give out static resources directly (accessed using /chrome/ URL) then you need to refresh them using the same command:
     68{{{
     69trac-admin /path/to/env deploy /deploy/path
     70}}}
     71this will extract static resources and CGI scripts (trac.wsgi, etc) from new Trac version and its plugins into `/deploy/path`.
     72
     73Some web browsers cache the CSS and Javascript file in a strong way, so you'll perhaps need to refresh the cache of the browsers by a force reload (and tell your users to do so!).
     74
     75=== 6. Steps specific to a given Trac version  ===
     76==== Upgrading from Trac 0.11 to Trac 0.12 ====
     77===== Python 2.3 no longer supported =====
     78The minimum supported version of python is now 2.4
     79
     80===== SQLite v3.x required =====
     81SQLite 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.
     82
     83===== Multiple Repository Support =====
     84If 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.
     85
     86This 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.
     87
     88===== Improved repository synchronization =====
     89In addition to supporting multiple repositories, a new more efficient method for synchronizing Trac and your repositories was implemented.
     90
     91While 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.
     92
     93Note 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.
     94
     95==== Upgrading from Trac 0.10 to Trac 0.11 ====
     96===== Site Templates and Styles =====
     97The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
     98
     99If 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.
     100
     101===== Trac Macros, Plugins =====
     102The 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.
     103
     104===== For FCGI/WSGI/CGI users =====
     105For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
     106{{{
     107trac-admin /path/to/env deploy /deploy/directory/path
     108}}}
     109
     110This 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.
     111
     112===== Web Admin plugin integrated =====
     113If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     114
     115=== 7. Restart the Web Server === #RestarttheWebServer
     116
    57117If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    58118
    59119== Known Issues ==
     120
    60121=== parent dir ===
    61122If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
    62 === some core modules won't load ===
    63 This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
    64 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:
    65 {{{
    66 ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
    67 }}}
    68 Remove the `Lib/site-packages/trac` folder and reinstall.
     123
     124=== Wiki Upgrade ===
     125`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.
     126
    69127
    70128== Changing Database Backend ==
    71 == SQLite to PostgreSQL ==
     129=== SQLite to PostgreSQL ===
    72130
    73131The [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
    … …  
    75133== Older Versions ==
    76134
    77 For upgrades from former versions refer to wiki:0.10/TracUpgrade.
     135For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
    78136
    79137-----