Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
03/14/14 17:52:04 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    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  
    84== Instructions == 
    95 
    10 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: 
    117 
    12 === Update the Trac Code === 
     8=== 1. Update the Trac Code === #UpdatetheTracCode 
    139 
    1410Get the new version as described in TracInstall, or your operating system specific procedure. 
    1511 
    16 If 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]). 
     12If you already have a 0.11 version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation: 
    1713 
    18 You 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. 
    19 The 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 
     14{{{ 
     15# easy_install --upgrade Trac==0.12 
     16}}} 
    2317 
    24 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). 
     18If you do a manual (not operating system-specific) upgrade, you should also stop any running Trac servers before the installation. Doing "hot" upgrades is not advised, especially on Windows ([trac:#7265]). 
    2519 
    26 This 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. 
     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 `.egg` files from former versions. 
     21The location of the site-packages directory depends on the operating system and the location in which Python was installed. However, the following locations are typical: 
     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` 
    2725 
    28 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base. 
     26You 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.) 
    2927 
    30 === Upgrade the Trac Environment === 
     28This cleanup is not mandatory, but 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=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment 
     31 
     32Environment upgrades are not necessary for minor version releases unless otherwise noted.  
    3133 
    3234After 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]: 
     
    3739This command will do nothing if the environment is already up-to-date. 
    3840 
    39 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: 
     41Note that a backup of your database will be performed automatically prior to the upgrade.  
     42This 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: 
    4043{{{ 
    4144trac-admin /path/to/projenv upgrade --no-backup 
    4245}}} 
    4346 
    44 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. 
    45  
    46 === Update the Trac Documentation === 
     47=== 3. Update the Trac Documentation === #UpdatetheTracDocumentation 
    4748 
    4849Every [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: 
     
    5152}}} 
    5253 
    53 Note that this procedure will of course leave your `WikiStart` page intact. 
     54Note that this procedure will leave your `WikiStart` page intact. 
    5455 
    55 === Site Templates === 
    56 The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information. 
     56=== 4. Resynchronize the Trac Environment Against the Source Code Repository === 
    5757 
    58 === Trac Macros, Plugins === 
    59 The 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. 
     58Each [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: 
    6059 
    61 === For CGI users === 
     60{{{ 
     61trac-admin /path/to/projenv repository resync '*' 
     62}}} 
    6263 
    63 For those who run Trac under the CGI environment, run this command in order to obtain the trac.cgi file: 
     64=== 5. Refresh static resources === 
     65 
     66If you have set up a web server to give out static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the same command: 
     67{{{ 
     68trac-admin /path/to/env deploy /deploy/path 
     69}}} 
     70this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`. 
     71 
     72Some web browsers cache CSS and Javascript files persistently, so you may need to instruct your users to manually erase the contents of their browser's cache. 
     73 
     74=== 6. Steps specific to a given Trac version  === 
     75==== Upgrading from Trac 0.11 to Trac 0.12 ==== 
     76===== Python 2.3 no longer supported ===== 
     77The minimum supported version of python is now 2.4 
     78 
     79===== SQLite v3.x required ===== 
     80SQLite v2.x is no longer supported. If you still use a Trac database of this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details. 
     81 
     82===== PySqlite 2 required ===== 
     83PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below). 
     84 
     85===== Multiple Repository Support ===== 
     86The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. 
     87 
     88This may be of interest to users with only one repository, since there's now a way to avoid the potentially costly resync check at every request. 
     89 
     90===== Improved repository synchronization ===== 
     91In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. 
     92 
     93While 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. 
     94 
     95Note 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. 
     96 
     97===== Authz permission checking ===== 
     98The authz permission checking has been migrated to a fine-grained permission policy. If you use authz permissions (aka `[trac] authz_file` and `authz_module_name`), you must add `AuthzSourcePolicy` in front of your permission policies in `[trac] permission_policies`. You must also remove `BROWSER_VIEW`, `CHANGESET_VIEW`, `FILE_VIEW` and `LOG_VIEW` from your global permissions (with `trac-admin $ENV permission remove` or the "Permissions" admin panel). 
     99 
     100===== Microsecond timestamps ===== 
     101All timestamps in database tables (except the `session` table) have been changed from "seconds since epoch" to "microseconds since epoch" values. This change should be transparent to most users, except for custom reports. If any of your reports use date/time columns in calculations (e.g. to pass them to `datetime()`), you must divide the values retrieved from the database by 1'000'000. Similarly, if a report provides a calculated value to be displayed as a date/time (i.e. with a column named "time", "datetime", "changetime", "date", "created" or "modified"), you must provide a microsecond timestamp, that is, multiply your previous calculation with 1'000'000. 
     102 
     103==== Upgrading from Trac 0.10 to Trac 0.11 ==== 
     104===== Site Templates and Styles ===== 
     105The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. 
     106 
     107If 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. 
     108 
     109===== Trac Macros, Plugins ===== 
     110The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of [trac: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. 
     111 
     112===== For FCGI/WSGI/CGI users ===== 
     113For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: 
    64114{{{ 
    65115trac-admin /path/to/env deploy /deploy/directory/path 
     
    68118This 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. 
    69119 
    70 === Restart the Web Server === 
     120===== Web Admin plugin integrated ===== 
     121If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11. 
     122 
     123=== 7. Restart the Web Server === #RestarttheWebServer 
     124 
    71125If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. 
    72126 
    73127== Known Issues == 
     128 
    74129=== parent dir === 
    75130If 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 ===  
    77 This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first. 
    78 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: 
    79 {{{ 
    80 ERROR: Skipping "trac.about = trac.about": (can't import "No module named about") 
    81 }}} 
    82 Remove the `Lib/site-packages/trac` folder and reinstall. 
     131 
    83132=== 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. 
     133`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. 
     134 
     135=== Trac database upgrade === 
     136 
     137A known issue in some versions of PySqlite (2.5.2-2.5.4) prevents the trac-admin upgrade script from successfully upgrading the database format. It is advised to use either a newer or older version of the sqlite python bindings to avoid this error. For more details see ticket [trac:#9434]. 
     138 
     139== Upgrading Python == 
     140 
     141Upgrading Python to a newer version will require reinstallation of Python packages: Trac of course; also [http://pypi.python.org/pypi/setuptools easy_install], if you've been using that.  Assuming you're using Subversion, you'll also need to upgrade the Python bindings for svn. 
     142 
     143=== Windows and Python 2.6 === 
     144 
     145If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [http://alagazam.net/ Algazam], which has the Python bindings readily available (see TracSubversion).  The good news is, that works with no tweaking. 
    85146 
    86147== Changing Database Backend == 
    87 == SQLite to PostgreSQL == 
     148=== SQLite to PostgreSQL === 
    88149 
    89150The [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 
     
    91152== Older Versions == 
    92153 
    93 For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade. 
    94  
    95 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. 
    96 {{{ 
    97 $ sqlite3 db/trac.db "update system set value=20 where name='database_version'" 
    98 }}} 
    99 (upgrade can be redone the normal way later on) 
     154For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions]. 
    100155 
    101156-----