Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
2017-10-15T03:11:40-08:00 (6 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v1 v2  
    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
     
    2931 * on MacOSX: `/Library/Python/2.X/site-packages`
    3032
    31 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.)
    32 
    33 This 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
     33You 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.
     34
     35=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    3636
    3737Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3838
    3939After 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]:
    40 {{{
     40{{{#!sh
    4141trac-admin /path/to/projenv upgrade
    4242}}}
    4343
    44 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.
    4545
    4646Note that a backup of your database will be performed automatically prior to the upgrade.
    47 This 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:
    48 {{{
     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
    4949trac-admin /path/to/projenv upgrade --no-backup
    5050}}}
     
    5252=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
    5353
    54 Every [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:
    55 {{{
     54By 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:
     55{{{#!sh
    5656trac-admin /path/to/projenv wiki upgrade
    5757}}}
     
    5959Note that this procedure will leave your `WikiStart` page intact.
    6060
    61 
    62 === 5. Refresh static resources ===
     61=== 5. Refresh static resources
    6362
    6463If 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 {{{
     64{{{#!sh
    6665trac-admin /path/to/env deploy /deploy/path
    6766}}}
     67
    6868this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    6969
     
    7373}}}
    7474
    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 The minimum supported version of python is now 2.5
     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
     81Upgrade 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.
    8192
    8293===== Subversion components not enabled by default for new installations
    8394The 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:
    84 {{{
     95{{{#!ini
    8596[components]
    8697tracopt.versioncontrol.svn.* = enabled
     
    8899The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    89100
    90 
    91101===== Attachments migrated to new location
    92 Another 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.
     102Another step in the automatic upgrade will change the way the attachments are stored. Create a backup of the `attachments` directory before upgrading. 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 to move them elsewhere and remove the `attachments` directory manually. The attachments themselves are now all located in your environment below the `files/attachments` directory.
    93103
    94104===== Behavior of `[ticket] default_owner` changed
    95105Prior 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.
    96106
    97 
    98 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
    99 
    100 ===== Python 2.3 no longer supported =====
    101 The minimum supported version of python is now 2.4
    102 
    103 ===== SQLite v3.x required =====
     107==== Upgrading from Trac 0.11 to Trac 0.12
     108
     109===== Python 2.3 no longer supported
     110
     111The minimum supported version of Python is now 2.4.
     112
     113===== SQLite v3.x required
     114
    104115SQLite 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.
    105116
    106 ===== PySqlite 2 required =====
    107 PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below).
    108 
    109 ===== Multiple Repository Support =====
     117===== [trac:PySqlite] 2 required
     118
     119[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
     120
     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
    110138The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    111139
    112 This 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.
    113 
    114 ===== Resynchronize the Trac Environment Against the Source Code Repository =====
     140This 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.
     141
     142===== Resynchronize the Trac Environment Against the Source Code Repository
    115143
    116144Each [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:
    117145
    118 {{{
     146{{{#!sh
    119147trac-admin /path/to/projenv repository resync '*'
    120148}}}
    121149
    122 ===== Improved repository synchronization =====
     150===== Improved repository synchronization
     151
    123152In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    124153
     
    127156Note 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.
    128157
    129 ===== Authz permission checking =====
    130 The 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).
    131 
    132 ===== Microsecond timestamps =====
    133 All 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.
    134 
    135 ==== Upgrading from Trac 0.10 to Trac 0.11 ====
    136 ===== Site Templates and Styles =====
     158===== Authz permission checking
     159
     160The 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.
     161
     162===== Microsecond timestamps
     163
     164All 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.
     165
     166==== Upgrading from Trac 0.10 to Trac 0.11
     167
     168===== Site Templates and Styles
     169
    137170The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    138171
    139 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.
    140 
    141 ===== Trac Macros, Plugins =====
    142 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] 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.
    143 
    144 ===== For FCGI/WSGI/CGI users =====
     172If 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.
     173
     174===== Trac Macros, Plugins
     175
     176The 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.
     177
     178===== For FCGI/WSGI/CGI users
     179
    145180For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    146 {{{
     181{{{#!sh
    147182trac-admin /path/to/env deploy /deploy/directory/path
    148183}}}
     
    150185This 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.
    151186
    152 ===== Web Admin plugin integrated =====
    153 If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    154 
    155 === 7. Restart the Web Server === #RestarttheWebServer
     187===== Web Admin plugin integrated
     188If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     189
     190===== New Default Configurable Workflow
     191
     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:
     193
     194{{{#!Workflow width=500 height=240
     195leave = * -> *
     196leave.operations = leave_status
     197leave.default = 1
     198accept = new -> assigned
     199accept.permissions = TICKET_MODIFY
     200accept.operations = set_owner_to_self
     201resolve = new,assigned,reopened -> closed
     202resolve.permissions = TICKET_MODIFY
     203resolve.operations = set_resolution
     204reassign = new,assigned,reopened -> new
     205reassign.permissions = TICKET_MODIFY
     206reassign.operations = set_owner
     207reopen = closed -> reopened
     208reopen.permissions = TICKET_CREATE
     209reopen.operations = del_resolution
     210}}}
     211
     212There 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.
     213
     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
    156218
    157219If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    158220
    159 == Known Issues ==
    160 
    161 Things you should pay attention to, while upgrading.
     221== Known Issues
    162222
    163223=== Customized Templates
    164224
    165 Trac 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 ;-)
    166 
    167 The 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.
    168 
    169 === !ZipImportError ===
    170 
    171 Due 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.
     225Trac 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 aware 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.
     226
     227The 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.
     228
     229=== !ZipImportError
     230
     231Due 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.
    172232See [trac:#7014] for details.
    173233
    174 === Wiki Upgrade ===
     234=== Wiki Upgrade
    175235`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.
    176236
    177 === Trac database upgrade ===
    178 
    179 A 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].
    180 
    181 === parent dir ===
    182 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
     237=== Trac database upgrade
     238
     239A 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].
     240
     241=== Parent dir
     242If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    183243
    184244== Related topics
    185245
    186 === Upgrading Python ===
    187 
    188 Upgrading 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.
    189 
    190 ==== Windows and Python 2.6 ====
    191 
    192 If 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.
    193 
    194 === Changing Database Backend ===
    195 
    196 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.
    197 
    198 === Upgrading from older versions of Trac === #OlderVersions
     246=== Upgrading Python
     247
     248Upgrading 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.
     249
     250==== Windows and Python 2.6
     251
     252If 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.
     253
     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
    199259
    200260For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].