Changes between Version 4 and Version 5 of TracUpgrade


Ignore:
Timestamp:
18/06/2010 11:33:50 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v4 v5  
    44== Instructions ==
    55
    6 Typically, there are five steps involved in upgrading to a newer version of Trac:
     6Typically, there are seven steps involved in upgrading to a newer version of Trac:
    77
    88=== 1. Update the Trac Code === #UpdatetheTracCode
     
    1010Get the new version as described in TracInstall, or your operating system specific procedure.
    1111
    12 If 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.
     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
    1414{{{
    15 # easy_install --upgrade Trac
     15# easy_install --upgrade Trac==0.12b1
    1616}}}
     17(once beta1 is released, that is)
    1718
    1819If 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]).
     
    2021You 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.
    2122The 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:
    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
     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`
    2526
    2627You 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).
    2728
    2829This 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.
    29 
    30 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    3130
    3231=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     
    4746}}}
    4847
    49 If 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 
    5148=== 3. Update the Trac Documentation === #UpdatetheTracDocumentation
    5249
     
    6360
    6461{{{
    65 trac-admin /path/to/projenv resync
     62trac-admin /path/to/projenv repository resync '*'
    6663}}}
    6764
    68 === 5. Steps specific to a given Trac version  ===
    69 ==== Upgrading to Trac 0.11 ====
    70 ===== Site Templates =====
    71 The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information.
     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.
    72100
    73101===== Trac Macros, Plugins =====
     
    82110This 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.
    83111
    84 === 6. Restart the Web Server === #RestarttheWebServer
     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
    85116
    86117If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
     
    90121=== parent dir ===
    91122If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
    92 
    93 === some core modules won't load ===
    94 This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
    95 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:
    96 {{{
    97 ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
    98 }}}
    99 Remove the `Lib/site-packages/trac` folder and reinstall.
    100123
    101124=== Wiki Upgrade ===
     
    110133== Older Versions ==
    111134
    112 For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade.
    113 
    114 Note 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)
     135For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
    119136
    120137-----