Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
Apr 16, 2015, 11:05:57 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v1 v2  
    11= Upgrade Instructions = 
    22[[TracGuideToc]] 
    3  
    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.  
     3[[PageOutline(2-4,,inline,unnumbered)]] 
    74 
    85== Instructions == 
    96 
    10 Typically, there are four steps involved in upgrading to a newer version of Trac: 
     7Typically, there are seven steps involved in upgrading to a newer version of Trac: 
    118 
    12 === Update the Trac Code === 
     9=== 1. Bring your server off-line 
     10 
     11It is not a good idea to update a running server: the server processes may have parts of the current packages cached in memory, and updating the code will likely trigger [#ZipImportError internal errors].  
     12 
     13=== 2. Update the Trac Code === #UpdatetheTracCode 
    1314 
    1415Get the new version as described in TracInstall, or your operating system specific procedure. 
    1516 
    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]). 
     17If 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: 
    1718 
    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 
     19{{{ 
     20# easy_install --upgrade Trac==0.12 
     21}}} 
    2322 
    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). 
     23If 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]). 
    2524 
    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. 
     25You 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. 
     26The 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: 
     27 * on Linux: `/usr/lib/python2.X/site-packages` 
     28 * on Windows: `C:\Python2.X\lib\site-packages` 
     29 * on MacOSX: `/Library/Python/2.X/site-packages` 
    2730 
    28 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base. 
     31You 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.) 
    2932 
    30 === Upgrade the Trac Environment === 
     33This 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. 
     34 
     35=== 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment 
     36 
     37Environment upgrades are not necessary for minor version releases unless otherwise noted.  
    3138 
    3239After 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]: 
     
    3744This command will do nothing if the environment is already up-to-date. 
    3845 
    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: 
     46Note that a backup of your database will be performed automatically prior to the upgrade.  
     47This 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: 
    4048{{{ 
    4149trac-admin /path/to/projenv upgrade --no-backup 
    4250}}} 
    4351 
    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 === 
     52=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation 
    4753 
    4854Every [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: 
     
    5157}}} 
    5258 
    53 Note that this procedure will of course leave your `WikiStart` page intact. 
     59Note that this procedure will leave your `WikiStart` page intact. 
    5460 
    55 === Site Templates === 
    56 The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information. 
    5761 
    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. 
     62=== 5. Refresh static resources === 
    6063 
    61 === For CGI users === 
     64If 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: 
     65{{{ 
     66trac-admin /path/to/env deploy /deploy/path 
     67}}} 
     68this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`. 
    6269 
    63 For those who run Trac under the CGI environment, run this command in order to obtain the trac.cgi file: 
     70Some web browsers (IE, Opera) cache CSS and Javascript files aggressively, so you may need to instruct your users to manually erase the contents of their browser's cache, a forced refreshed (`<F5>`) should be enough. 
     71{{{#!comment 
     72Remove above note once #9936 is fixed. 
     73}}} 
     74 
     75=== 6. Steps specific to a given Trac version  === 
     76==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0 
     77 
     78The Trac components for Subversion support are no longer enabled by default. To enable the svn support, you need to make sure the `tracopt.versioncontrol.svn` components are enabled, for example by setting the following in the TracIni: 
     79{{{ 
     80[components] 
     81tracopt.versioncontrol.svn.* = enabled 
     82}}} 
     83The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled. 
     84 
     85Another step in the automatic upgrade will change the way the attachments are stored. If you're a bit paranoid, you might want to take a backup of the `attachments` directory before upgrading (but if you are, you already did a full copy of the environment, no?). In case the `attachments` directory contains some files which are //not// attachments, the last step of the migration to the new layout will fail: the deletion of the now unused `attachments` directory can't be done if there are still files and folders in it. You may ignore this error, but better go have a look to these files, move them elsewhere and remove the `attachments` directory manually to cleanup the environment. The attachments themselves are now all located in your environment below the `files/attachments` directory. 
     86 
     87 
     88==== Upgrading from Trac 0.11 to Trac 0.12 ==== 
     89 
     90===== Python 2.3 no longer supported ===== 
     91The minimum supported version of python is now 2.4 
     92 
     93===== SQLite v3.x required ===== 
     94SQLite 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. 
     95 
     96===== PySqlite 2 required ===== 
     97PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below). 
     98 
     99===== Multiple Repository Support ===== 
     100The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. 
     101 
     102This 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. 
     103 
     104===== Resynchronize the Trac Environment Against the Source Code Repository ===== 
     105 
     106Each [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: 
     107 
     108{{{ 
     109trac-admin /path/to/projenv repository resync '*' 
     110}}} 
     111 
     112===== Improved repository synchronization ===== 
     113In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. 
     114 
     115While 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. 
     116 
     117Note 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 and [TracWorkflow#Howtocombinethetracopt.ticket.commit_updaterwiththetestingworkflow here], 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. 
     118 
     119===== Authz permission checking ===== 
     120The 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). 
     121 
     122===== Microsecond timestamps ===== 
     123All 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. 
     124 
     125==== Upgrading from Trac 0.10 to Trac 0.11 ==== 
     126===== Site Templates and Styles ===== 
     127The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. 
     128 
     129If 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. 
     130 
     131===== Trac Macros, Plugins ===== 
     132The 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. 
     133 
     134===== For FCGI/WSGI/CGI users ===== 
     135For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: 
    64136{{{ 
    65137trac-admin /path/to/env deploy /deploy/directory/path 
     
    68140This 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. 
    69141 
    70 === Restart the Web Server === 
     142===== Web Admin plugin integrated ===== 
     143If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11. 
     144 
     145=== 7. Restart the Web Server === #RestarttheWebServer 
     146 
    71147If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. 
    72148 
    73149== Known Issues == 
     150 
     151Things you should pay attention to, while upgrading. 
     152 
     153=== Customized Templates 
     154 
     155Trac supports customization of its Genshi templates by placing copies of the templates in the `<env>/templates` folder of your [TracEnvironment environment] or in a common location specified in the [[TracIni#GlobalConfiguration| [inherit] templates_dir]] configuration setting. If you choose to do so, be wary that you will need to repeat your changes manually on a copy of the new templates when you upgrade to a new release of Trac (even a minor one), as the templates will likely evolve. So keep a diff around ;-) 
     156 
     157The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation, as this is more robust in case of changes: we usually won't modify element `id`s or change CSS `class`es, and if we have to do so, this will be documented in the TracDev/ApiChanges pages. 
     158 
     159=== !ZipImportError === 
     160 
     161Due to internal caching of zipped packages,  whenever the content of the packages change on disk, the in-memory zip index will no longer match and you'll get irrecoverable !ZipImportError errors. Better anticipate and bring your server down for maintenance before upgrading. 
     162See [trac:#7014] for details. 
     163 
     164=== Wiki Upgrade === 
     165`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. 
     166 
     167=== Trac database upgrade === 
     168 
     169A 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]. 
     170 
    74171=== parent dir === 
    75172If 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. 
    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. 
    85173 
    86 == Changing Database Backend == 
    87 == SQLite to PostgreSQL == 
     174== Related topics 
     175 
     176=== Upgrading Python === 
     177 
     178Upgrading 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. 
     179 
     180==== Windows and Python 2.6 ==== 
     181 
     182If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [http://alagazam.net/ Alagazam], which has the Python bindings readily available (see TracSubversion).  The good news is, that works with no tweaking. 
     183 
     184=== Changing Database Backend === 
     185==== SQLite to PostgreSQL ==== 
    88186 
    89187The [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 
    90188 
    91 == Older Versions == 
     189=== Upgrading from older versions of Trac === #OlderVersions 
    92190 
    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) 
     191For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions]. 
    100192 
    101193-----