Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
Jul 6, 2013 6:47:50 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    11= Upgrade Instructions =
    22[[TracGuideToc]]
     3[[PageOutline(2-3,,inline,unnumbered)]]
    34
    45== Instructions ==
    56
    6 Typically, there are five steps involved in upgrading to a newer version of Trac:
     7Typically, there are seven steps involved in upgrading to a newer version of Trac:
    78
    8 === 1. Update the Trac Code === #UpdatetheTracCode
     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
    914
    1015Get the new version as described in TracInstall, or your operating system specific procedure.
    1116
    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.
     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:
    1318
    1419{{{
    15 # easy_install --upgrade Trac
     20# easy_install --upgrade Trac==0.12
    1621}}}
    1722
    18 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]).
     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]).
    1924
    20 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.
    21 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:
    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
     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`
    2530
    26 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).
     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.)
    2732
    28 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.
     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.
    2934
    30 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    31 
    32 === 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     35=== 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
    3336
    3437Environment upgrades are not necessary for minor version releases unless otherwise noted.
     
    4750}}}
    4851
    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 
    51 === 3. Update the Trac Documentation === #UpdatetheTracDocumentation
     52=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
    5253
    5354Every [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:
     
    5657}}}
    5758
    58 Note that this procedure will of course leave your `WikiStart` page intact.
     59Note that this procedure will leave your `WikiStart` page intact.
    5960
    60 === 4. Resynchronize the Trac Environment Against the Source Code Repository ===
     61
     62=== 5. Refresh static resources ===
     63
     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`.
     69
     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.11 to Trac 0.12 ====
     77
     78===== Python 2.3 no longer supported =====
     79The minimum supported version of python is now 2.4
     80
     81===== SQLite v3.x required =====
     82SQLite 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.
     83
     84===== PySqlite 2 required =====
     85PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below).
     86
     87===== Multiple Repository Support =====
     88The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
     89
     90This 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.
     91
     92===== Resynchronize the Trac Environment Against the Source Code Repository =====
    6193
    6294Each [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:
    6395
    6496{{{
    65 trac-admin /path/to/projenv resync
     97trac-admin /path/to/projenv repository resync '*'
    6698}}}
    6799
    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.
     100===== Improved repository synchronization =====
     101In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
     102
     103While 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.
     104
     105Note 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.
     106
     107===== Authz permission checking =====
     108The 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).
     109
     110===== Microsecond timestamps =====
     111All 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.
     112
     113==== Upgrading from Trac 0.10 to Trac 0.11 ====
     114===== Site Templates and Styles =====
     115The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
     116
     117If 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.
    72118
    73119===== Trac Macros, Plugins =====
    74 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.
     120The 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.
    75121
    76122===== For FCGI/WSGI/CGI users =====
     
    82128This 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.
    83129
    84 === 6. Restart the Web Server === #RestarttheWebServer
     130===== Web Admin plugin integrated =====
     131If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     132
     133=== 7. Restart the Web Server === #RestarttheWebServer
    85134
    86135If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
     
    88137== Known Issues ==
    89138
    90 === parent dir ===
    91 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
     139Things you should pay attention to, while upgrading.
    92140
    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.
     141=== Customized Templates
     142
     143Trac 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 ;-)
     144
     145The 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.
     146
     147=== !ZipImportError ===
     148
     149Due 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.
     150See [trac:#7014] for details.
    100151
    101152=== Wiki Upgrade ===
    102153`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.
    103154
     155=== Trac database upgrade ===
    104156
    105 == Changing Database Backend ==
    106 === SQLite to PostgreSQL ===
     157A 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].
     158
     159=== parent dir ===
     160If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
     161
     162== Related topics
     163
     164=== Upgrading Python ===
     165
     166Upgrading 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.
     167
     168==== Windows and Python 2.6 ====
     169
     170If 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.
     171
     172=== Changing Database Backend ===
     173==== SQLite to PostgreSQL ====
    107174
    108175The [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
    109176
    110 == Older Versions ==
     177=== Upgrading from older versions of Trac === #OlderVersions
    111178
    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)
     179For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
    119180
    120181-----