Changes between Version 4 and Version 5 of TracUpgrade


Ignore:
Timestamp:
Nov 23, 2016, 6:53:44 AM (12 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v4 v5  
    1 = Upgrade Instructions =
     1= Upgrade Instructions
    22[[TracGuideToc]]
    33[[PageOutline(2-4,,inline,unnumbered)]]
    44
    5 == Instructions ==
     5== Instructions
    66
    77Typically, there are seven steps involved in upgrading to a newer version of Trac:
     
    99=== 1. Bring your server off-line
    1010
    11 It 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
     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
     13Although a database backup will be implicitly created by default when upgrading the environment, it is always a good idea to perform a full backup of the environment using the [TracBackup hotcopy] command before beginning.
     14
     15=== 2. Update the Trac Code #UpdatetheTracCode
    1416
    1517Get the new version as described in TracInstall, or your operating system specific procedure.
     
    1719If you already have a 0.12 version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:
    1820
    19 {{{
    20 # easy_install --upgrade Trac==1.0
     21{{{#!sh
     22easy_install --upgrade Trac==1.0
    2123}}}
    2224
     
    3133You 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. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before actually removing things.
    3234
    33 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     35=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    3436
    3537Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3638
    3739After 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]:
    38 {{{
     40{{{#!sh
    3941trac-admin /path/to/projenv upgrade
    4042}}}
    4143
    42 This command will do nothing if the environment is already up-to-date.
     44This command will not have any effect if the environment is already up-to-date.
    4345
    4446Note that a backup of your database will be performed automatically prior to the upgrade.
    45 This feature is relatively new for PostgreSQL or MySQL databases, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:
    46 {{{
     47This feature is relatively new for PostgreSQL or MySQL databases, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade:
     48{{{#!sh
    4749trac-admin /path/to/projenv upgrade --no-backup
    4850}}}
     
    5153
    5254By default, every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. However, to keep the included documentation in sync with the installed version of Trac, use the following [TracAdmin trac-admin] command to upgrade the documentation:
    53 {{{
     55{{{#!sh
    5456trac-admin /path/to/projenv wiki upgrade
    5557}}}
     
    5759Note that this procedure will leave your `WikiStart` page intact.
    5860
    59 === 5. Refresh static resources ===
     61=== 5. Refresh static resources
    6062
    6163If 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:
    62 {{{
     64{{{#!sh
    6365trac-admin /path/to/env deploy /deploy/path
    6466}}}
     67
    6568this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    6669
     
    7073}}}
    7174
    72 === 6. Steps specific to a given Trac version  ===
    73 
    74 ==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0
    75 
    76 ===== Python 2.4 no longer supported =====
     75=== 6. Steps specific to a given Trac version
     76
     77==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     78
     79===== Python 2.4 no longer supported
     80
    7781Upgrade Python to at least 2.5, but not 3.0.
     82
     83===== Obsolete Plugins
     84
     85Trac has added functionality equivalent to the following plugins:
     86
     87* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
     88* ​[https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     89* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
     90
     91The plugins should be removed when upgrading Trac to 1.0.
    7892
    7993===== Subversion components not enabled by default for new installations
    8094The 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:
    81 {{{
     95{{{#!ini
    8296[components]
    8397tracopt.versioncontrol.svn.* = enabled
     
    91105Prior to 1.0, the owner field of new tickets always defaulted to `[ticket] default_owner` when the value was not empty. If the value was empty, the owner field defaulted to to the Component's owner. In 1.0 and later, the `default_owner` must be set to `< default >` to make new tickets default to the Component's owner. This change allows the `default_owner` to be set to an empty value if no default owner is desired.
    92106
    93 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
    94 
    95 ===== Python 2.3 no longer supported =====
     107==== Upgrading from Trac 0.11 to Trac 0.12
     108
     109===== Python 2.3 no longer supported
     110
    96111The minimum supported version of Python is now 2.4.
    97112
    98 ===== SQLite v3.x required =====
     113===== SQLite v3.x required
     114
    99115SQLite 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.
    100116
    101 ===== [trac:PySqlite] 2 required =====
     117===== [trac:PySqlite] 2 required
     118
    102119[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    103120
    104 ===== Multiple Repository Support =====
     121===== Obsolete Plugins
     122
     123Trac has added functionality equivalent to the following plugins:
     124
     125* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
     126* ​[https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     127* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
     128* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
     129* [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter`
     130* [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories
     131* [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole]
     132* [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1)
     133
     134The plugins should be removed when upgrading Trac to 0.12.
     135
     136===== Multiple Repository Support
     137
    105138The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    106139
    107140This may be of interest to users with only one repository, since there is now a way to avoid the potentially costly resync check at every request.
    108141
    109 ===== Resynchronize the Trac Environment Against the Source Code Repository =====
     142===== Resynchronize the Trac Environment Against the Source Code Repository
    110143
    111144Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[trac:#6120 No changeset ??? in the repository]" while browsing the source through the Trac interface:
    112145
    113 {{{
     146{{{#!sh
    114147trac-admin /path/to/projenv repository resync '*'
    115148}}}
    116149
    117 ===== Improved repository synchronization =====
     150===== Improved repository synchronization
     151
    118152In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    119153
     
    122156Note 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.
    123157
    124 ===== Authz permission checking =====
     158===== Authz permission checking
     159
    125160The 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.
    126161
    127 ===== Microsecond timestamps =====
     162===== Microsecond timestamps
     163
    128164All 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.
    129165
    130 ==== Upgrading from Trac 0.10 to Trac 0.11 ====
    131 ===== Site Templates and Styles =====
     166==== Upgrading from Trac 0.10 to Trac 0.11
     167
     168===== Site Templates and Styles
     169
    132170The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    133171
    134172If you are using custom CSS 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.
    135173
    136 ===== Trac Macros, Plugins =====
     174===== Trac Macros, Plugins
     175
    137176The 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.
    138177
    139 ===== For FCGI/WSGI/CGI users =====
     178===== For FCGI/WSGI/CGI users
     179
    140180For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    141 {{{
     181{{{#!sh
    142182trac-admin /path/to/env deploy /deploy/directory/path
    143183}}}
     
    145185This 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.
    146186
    147 ===== Web Admin plugin integrated =====
     187===== Web Admin plugin integrated
    148188If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    149189
    150190===== New Default Configurable Workflow
    151191
    152 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.
    153 
    154 Graphically, that looks like this:
     192When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10:
    155193
    156194{{{#!Workflow width=500 height=240
     
    174212There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful. See TracWorkflow for a detailed description of the new basic workflow.
    175213
    176 === 7. Restart the Web Server === #RestarttheWebServer
     214===== Global Configuration
     215In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or `/etc/trac/trac.ini`, depending on the distribution. You may want to specify that file to inherit from when upgrading.  Literally, when upgrading you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location.
     216
     217=== 7. Restart the Web Server #RestarttheWebServer
    177218
    178219If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    179220
    180 == Known Issues ==
     221== Known Issues
    181222
    182223=== Customized Templates
     
    186227The 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 [trac:TracDev/ApiChanges] pages.
    187228
    188 === !ZipImportError ===
     229=== !ZipImportError
    189230
    190231Due 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.
    191232See [trac:#7014] for details.
    192233
    193 === Wiki Upgrade ===
     234=== Wiki Upgrade
    194235`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.
    195236
    196 === Trac database upgrade ===
     237=== Trac database upgrade
    197238
    198239A known issue in some versions of [trac: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].
    199240
    200 === Parent dir ===
     241=== Parent dir
    201242If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    202243
    203244== Related topics
    204245
    205 === Upgrading Python ===
     246=== Upgrading Python
    206247
    207248Upgrading Python to a newer version will require reinstallation of Python packages: Trac itself of course, but also [http://pypi.python.org/pypi/setuptools easy_install], if you've been using that. If you are using Subversion, you'll also need to upgrade the Python bindings for svn.
    208249
    209 ==== Windows and Python 2.6 ====
     250==== Windows and Python 2.6
    210251
    211252If 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 [trac:TracSubversion]. That package works without tweaking.
    212253
    213 === Changing Database Backend ===
    214 
    215 The [http://trac-hacks.org/wiki/TracMigratePlugin TracMigratePlugin] on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating between SQLite, MySQL and PostgreSQL databases.
    216 
    217 === Upgrading from older versions of Trac === #OlderVersions
     254=== Changing Database Backend
     255
     256The [https://trac-hacks.org/wiki/TracMigratePlugin TracMigratePlugin] on [https://trac-hacks.org trac-hacks.org] has been written to assist in migrating between SQLite, MySQL and PostgreSQL databases.
     257
     258=== Upgrading from older versions of Trac #OlderVersions
    218259
    219260For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].