Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
03/31/2010 06:01:49 PM (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v2 v3  
    22[[TracGuideToc]]
    33
    4 A 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.
     4A [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.
    55
    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).''
     6Environment upgrades are not necessary for minor version releases unless otherwise noted.
    77
    8 == General Instructions ==
     8== Instructions ==
    99
    1010Typically, there are four steps involved in upgrading to a newer version of Trac:
    … …  
    1212=== Update the Trac Code ===
    1313
    14 Get the new version of Trac, either by downloading an offical release package or by checking it out from the [http://projects.edgewall.com/trac/wiki/SubversionRepository Subversion repository].
     14Get the new version as described in TracInstall, or your operating system specific procedure.
    1515
    16 If 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).
     16If 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]).
    1717
    18 If you have a source distribution, you need to run
    19 {{{
    20 python setup.py install
    21 }}}
     18You 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.
     19The 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
    2223
    23 to install the new version. If you've downloaded the Windows installer, you execute it, and so on.
     24You 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).
     25
     26This 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.
     27
     28If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    2429
    2530=== Upgrade the Trac Environment ===
    2631
    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]:
     32After 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]:
    2833{{{
    2934trac-admin /path/to/projenv upgrade
    … …  
    3742}}}
    3843
     44If 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.
     45
    3946=== Update the Trac Documentation ===
    4047
    41 Every [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:
     48Every [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:
    4249{{{
    4350trac-admin /path/to/projenv wiki upgrade
    … …  
    4653Note that this procedure will of course leave your `WikiStart` page intact.
    4754
    48 === Restart the Web Server ===
     55=== Site Templates ===
     56The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information.
    4957
    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]).
     58=== Trac Macros, Plugins ===
     59The 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.
    5160
    52 == Specific Versions ==
     61=== For CGI users ===
    5362
    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:
     63For those who run Trac under the CGI environment, run this command in order to obtain the trac.cgi file:
    6664{{{
    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:
    90 
    91 {{{
    92 [timeline]
    93 ticket_show_details = true
     65trac-admin /path/to/env deploy /deploy/directory/path
    9466}}}
    9567
    96 == From 0.8.x to 0.9 ==
     68This 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.
    9769
    98 [wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration:
     70=== Restart the Web Server ===
     71If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
     72
     73== Known Issues ==
     74=== parent dir ===
     75If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
     76=== some core modules won't load ===
     77This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
     78Some 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:
    9979{{{
    100    from: PythonHandler trac.ModPythonHandler
    101    to:   PythonHandler trac.web.modpython_frontend
     80ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
    10281}}}
     82Remove the `Lib/site-packages/trac` folder and reinstall.
     83=== 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.
    10385
    104 If you have [http://initd.org/tracker/pysqlite 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.
     86== Changing Database Backend ==
     87== SQLite to PostgreSQL ==
    10588
    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:
     89The [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
     90
     91== Older Versions ==
     92
     93For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade.
     94
     95Note 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.
    10796{{{
    108  $ mv trac.db trac2.db
    109  $ sqlite trac2.db .dump | sqlite3 trac.db
     97$ sqlite3 db/trac.db "update system set value=20 where name='database_version'"
    11098}}}
    111 
    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):
    113 {{{
    114  $ find /var/trac/ -iname "trac.db" | xargs -i bash -c "mv {} {}.2; sqlite {}.2 .dump | sqlite3 {};"
    115 }}}
    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 }}}
     99(upgrade can be redone the normal way later on)
    131100
    132101-----