Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
Aug 23, 2010 11:39:44 AM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v1 v2  
    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. 
     4== Instructions == 
    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).'' 
     6Typically, there are seven steps involved in upgrading to a newer version of Trac: 
    77 
    8 == General Instructions == 
     8=== 1. Update the Trac Code === #UpdatetheTracCode 
    99 
    10 Typically, there are four steps involved in upgrading to a newer version of Trac: 
     10Get the new version as described in TracInstall, or your operating system specific procedure. 
    1111 
    12 === Update the Trac Code === 
     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. 
    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]. 
     14{{{ 
     15# easy_install --upgrade Trac==0.12b1 
     16}}} 
     17(once beta1 is released, that is) 
    1518 
    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). 
     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]). 
    1720 
    18 If you have a source distribution, you need to run 
    19 {{{ 
    20 python setup.py install 
    21 }}} 
     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. 
     22The 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: 
     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` 
    2226 
    23 to install the new version. If you've downloaded the Windows installer, you execute it, and so on. 
     27You 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). 
    2428 
    25 === Upgrade the Trac Environment === 
     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. 
    2630 
    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]: 
     31=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment 
     32 
     33Environment upgrades are not necessary for minor version releases unless otherwise noted.  
     34 
     35After 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]: 
    2836{{{ 
    2937trac-admin /path/to/projenv upgrade 
     
    3240This command will do nothing if the environment is already up-to-date. 
    3341 
    34 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: 
    3544{{{ 
    3645trac-admin /path/to/projenv upgrade --no-backup 
    3746}}} 
    3847 
    39 === Update the Trac Documentation === 
     48=== 3. Update the Trac Documentation === #UpdatetheTracDocumentation 
    4049 
    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: 
     50Every [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: 
    4251{{{ 
    4352trac-admin /path/to/projenv wiki upgrade 
     
    4655Note that this procedure will of course leave your `WikiStart` page intact. 
    4756 
    48 === Restart the Web Server === 
     57=== 4. Resynchronize the Trac Environment Against the Source Code Repository === 
    4958 
    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]). 
    51  
    52 == Specific Versions == 
    53  
    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: 
    66 {{{ 
    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: 
     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: 
    9060 
    9161{{{ 
    92 [timeline] 
    93 ticket_show_details = true 
     62trac-admin /path/to/projenv repository resync '*' 
    9463}}} 
    9564 
    96 == From 0.8.x to 0.9 == 
     65=== 5. Refresh static resources === 
    9766 
    98 [wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration: 
     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: 
    9968{{{ 
    100    from: PythonHandler trac.ModPythonHandler 
    101    to:   PythonHandler trac.web.modpython_frontend 
     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 
    102108}}} 
    103109 
    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. 
     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. 
    105111 
    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: 
    107 {{{ 
    108  $ mv trac.db trac2.db 
    109  $ sqlite trac2.db .dump | sqlite3 trac.db 
    110 }}} 
     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. 
    111114 
    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 }}} 
     115=== 7. Restart the Web Server === #RestarttheWebServer 
    116116 
    117 Remember the give the webserver write permission to trac.db. 
     117If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. 
    118118 
    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. 
     119== Known Issues == 
    120120 
    121 == From 0.7.x to 0.8 == 
     121=== parent dir === 
     122If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work. 
    122123 
    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 }}} 
     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 
     127 
     128== Changing Database Backend == 
     129=== SQLite to PostgreSQL === 
     130 
     131The [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 
     132 
     133== Older Versions == 
     134 
     135For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions]. 
    131136 
    132137-----