Changes between Version 1 and Version 2 of TracUpgrade

07/10/20 13:09:46 (2 years ago)



  • TracUpgrade

    v1 v2  
    1 = Upgrade Instructions =
     1= Upgrade Instructions
    4 A Trac environment sometimes needs to be upgraded before it can be used with a new version of Trac. This document describes the steps necessary to upgrade an environment.
    6  '''Note''': ''Environment upgrades are not necessary for minor version releases unless otherwise noted. For example, there's no need to upgrade a Trac environment created with (or upgraded) 0.8.0 when installing 0.8.4 (or any other 0.8.x release).''
    8 == General Instructions ==
    10 Typically, there are four steps involved in upgrading to a newer version of Trac:
    12 === Update the Trac Code ===
    14 Get the new version of Trac, either by downloading an offical release package or by checking it out from the [ Subversion repository].
    16 If you're doing a major version upgrade (such as from 0.8 to 0.9), it is ''highly'' recommended that you first remove the existing Trac code. To do this, you need to delete the `trac` directory from the Python `lib/site-packages` directory. 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).
    18 If you have a source distribution, you need to run
    19 {{{
    20 python install
    21 }}}
    23 to install the new version. If you've downloaded the Windows installer, you execute it, and so on.
    25 === Upgrade the Trac Environment ===
    27 Unless noted otherwise, upgrading between major versions (such as 0.8 and 0.9) involves changes to the database schema, and possibly the layout of the [wiki:TracEnvironment environment directory]. Fortunately, Trac provides automated upgrade scripts to ease the pain. These scripts are run via [wiki:TracAdmin trac-admin]:
    28 {{{
    29 trac-admin /path/to/projenv upgrade
    30 }}}
    32 This command will do nothing if the environment is already up-to-date.
    34 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:
    35 {{{
    36 trac-admin /path/to/projenv upgrade --no-backup
    37 }}}
    39 === Update the Trac Documentation ===
    41 Every [wiki: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, [wiki:TracAdmin trac-admin] provides a command to upgrade the documentation:
    42 {{{
    43 trac-admin /path/to/projenv wiki upgrade
    44 }}}
    46 Note that this procedure will of course leave your `WikiStart` page intact.
    48 === Restart the Web Server ===
    50 In order to reload the new Trac code you will need to restart your web server (note this is not necessary for [wiki:TracCgi CGI]).
    52 == Specific Versions ==
    54 The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac.
    56 == From 0.9.x to 0.10.x ==
    58 Due to some changes in the Wiki syntax, you may notice that certain parts of your pages no longer work as expected:
    59  * Previously, links to images would result in that image being embedded into the page. Since 0.10, links to images remain plain links. If you want to embed an image in the page, use the `[[Image]]` macro.
    60  * You can no longer use `%20` in wiki links to encode spaces. Instead, you should quote the name containing spaces (for example, use `wiki:"My page"` instead of `wiki:My%20page`.)
    62 Several enhancements have been made to the version control subsystem, in particular for the support of scoped repositories has been improved.
    63 It is recommended that you perform a [TracAdmin#InteractiveMode trac-admin] '''`resync`''' operation to take advantage of these improvements.
    65 Also note that the argument list of the [TracAdmin trac-admin] '''`initenv`''' command has changed: there's a new argument for determining the type of version control system. The old usage was:
    66 {{{
    67    initenv <projectname> <db> <repospath> <templatepath>
    68 }}}
    69 The new usage is:
    70 {{{
    71    initenv <projectname> <db> <repostype> <repospath> <templatepath>
    72 }}}
    73 If you're using any scripts that automate the creation of Trac environments, you will need to update them. If you're using Subversion, specify `svn` for the `<repostype>` argument.
    75 == From 0.9.3 to 0.9.4 ==
    77 There is a bug in Pysqlite 1.x that causes reports using the "%" character for `LIKE` clauses or date formatting to fail.  You will need to use escape the percent characters with another: "%%".
    79 == From 0.9.x to 0.9.3 or later ==
    81 If you are using plugins you might need to upgrade them. See for further details.
    83 == From 0.9-beta to 0.9 ==
    85 If inclusion of the static resources (style sheets, javascript, images) is not working, check the value of the `htdocs_location` in trac.ini. For [wiki:TracModPython mod_python], [wiki:TracStandalone Tracd] and [wiki:TracFastCgi FastCGI], you can simply remove the option altogether. For [wiki:TracCgi CGI], you should fix it to point to the URL you mapped the Trac `htdocs` directory to (although you can also remove it and then [wiki:TracCgi#MappingStaticResources map the static resources]). If you're still having problems after removing the option, check the paths in the `trac/` file and fix them if they're incorrect.
    87 If you've been using plugins with a beta release of Trac 0.9, or have disabled some of the built-in components, you might have to update the rules for disabling/enabling components in [wiki:TracIni trac.ini]. In particular, globally installed plugins now need to be enabled explicitly. See TracPlugins and TracIni for more information.
    89 If you want to enable the display of all ticket changes in the timeline (the “Ticket Details” option), you now have to explicitly enable that in [wiki:TracIni trac.ini], too:
    91 {{{
    92 [timeline]
    93 ticket_show_details = true
    94 }}}
    96 == From 0.8.x to 0.9 ==
    98 [wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration:
    99 {{{
    100    from: PythonHandler trac.ModPythonHandler
    101    to:   PythonHandler trac.web.modpython_frontend
    102 }}}
    104 If you have [ PySQLite] 2.x installed, Trac will now try to open your SQLite database using the SQLite 3.x file format. The database formats used by SQLite 2.8.x and SQLite 3.x are incompatible. If you get an error like ''“file is encrypted or is not a database”'' after upgrading, then you must convert your database file.
    106 To do this, you need to have both SQLite 2.8.x and SQLite 3.x installed (they have different filenames so can coexist on the same system). Then use the following commands:
    107 {{{
    108  $ mv trac.db trac2.db
    109  $ sqlite trac2.db .dump | sqlite3 trac.db
    110 }}}
    112 To update multiple database files at once on linux you may use the following command (replace {{{/var/trac}}} withe the location where your trac installtions reside):
    113 {{{
    114  $ find /var/trac/ -iname "trac.db" | xargs -i bash -c "mv {} {}.2; sqlite {}.2 .dump | sqlite3 {};"
    115 }}}
    117 Remember the give the webserver write permission to trac.db.
    119 After testing that the conversion was successful, the `trac2.db` file can be deleted. For more information on the SQLite upgrade see
    121 == From 0.7.x to 0.8 ==
    123 0.8 adds a new roadmap feature which requires additional permissions. While a
    124 fresh installation will by default grant ROADMAP_VIEW and MILESTONE_VIEW
    125 permissions to anonymous, these permissions have to be granted manually when
    126 upgrading:
    127 {{{
    128  $ trac-admin /path/to/projectenv permission add anonymous MILESTONE_VIEW
    129  $ trac-admin /path/to/projectenv permission add anonymous ROADMAP_VIEW
    130 }}}
     5== Instructions
     7There are seven recommended steps for upgrading to a newer version of Trac:
     9=== 1. Check your plugins
     11Check whether your plugins are compatible with the version of Trac that you are upgrading to. Obsolete plugins listed in the [#VersionSpecificSteps version specific steps] below should be uninstalled or disabled.
     13If you are upgrading to a minor release, plugin compatibility is usually not a concern because the Trac API is normally unchanged.
     15If your plugins are installed from [] you can check compatibility by looking for a tag on the project page corresponding to a major release (e.g. `1.4`). If you are unsure, you'll want to contact the plugin author or ask on the [trac:MailingList MailingList].
     17If you are running several Trac plugins it is good to test the upgrade and plugin functionality in a staging instance of your site before upgrading your production instance. Remember, plugin authors are responsible for Trac version compatibility and plugins can interact in unexpected ways. Your Trac instance may have a unique combination of plugins and therefore it's advised that you do some verification testing when making any changes to your site.
     19=== 2. Bring your server off-line
     21It 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].
     23Although 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. You may also wish to create a full backup of your server.
     25=== 3. Update Trac and dependencies #UpdatetheTracCode
     27The packages are available through several channels, as described in [trac:TracDownload]. If your Trac instance was installed through an operating system package manager, proceed with the standard steps that are appropriate for your operating system package manager. If it was installed through a Windows installer, uninstall the old Trac package before installing new Trac package.
     29If you are managing your Trac installation using command line tools, `pip` is the preferred tool to upgrade a Trac instance because it will uninstall the old version. The following command will upgrade your Trac installation using the package published to [ PyPI].
     32$ pip install --upgrade Trac
     35The upgrade command will give you the latest release of Trac. If instead you wish to upgrade to a different version, such as a minor release of Trac when there is a newer major release available, then specify the Trac version in the `pip` command.
     38$ pip install --upgrade Trac==1.4.1
     41You should also upgrade dependencies so they are compliant with the [TracInstall#Dependencies required versions].
     43=== 4. Upgrade the Trac Environment #UpgradetheTracEnvironment
     45Environment upgrades are not necessary for minor version releases unless otherwise noted.
     47On starting your web server after upgrading Trac, a message will be displayed for projects that need to be upgraded and the projects will not be accessible until the upgrade is run.
     49The upgrade is run using a [TracAdmin trac-admin] command:
     51$ trac-admin /path/to/projenv upgrade
     54This command will not have any effect if the environment is already up-to-date.
     56It is recommended that you set the [[TracIni#logging-log_level-option|log_level]] to `INFO` before running the upgrade. The additional information in the logs can be helpful in case something unexpected occurs during the upgrade.
     58Note that a backup of your database will be performed automatically prior to the upgrade. The backup is saved in the location specified by [[TracIni#trac-backup_dir-option|backup_dir]].
     60=== 5. Update the Trac Documentation === #UpdatetheTracDocumentation
     62By default, every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. To keep the documentation in sync with the installed version of Trac, upgrade the documentation:
     64$ trac-admin /path/to/projenv wiki upgrade
     67Note that this procedure will leave your `WikiStart`, `InterMapTxt` and `SandBox` pages unaltered. Local changes to other pages that are distributed with Trac will be overwritten, however these pages are read-only by default for Environments created in Trac 1.3.3 and later.
     69=== 6. Refresh static resources
     71If you have configured your web server to serve static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the [TracInstall#MappingStaticResources deploy command]. The `deploy` command will extract static resources and CGI scripts (`trac.wsgi`, etc) from the new Trac version and plugins into `/deploy/path`.
     73$ trac-admin /path/to/env deploy /deploy/path
     76Before refreshing, it is recommended that you remove the directory in which your static resources are deployed. The directory location depends on the choice you made during installation. This cleanup is not mandatory, but makes it easier to troubleshoot issues as your installation is uncluttered by unused assets from a previous release. As usual, make a backup before deleting the directory.
     78{{{#!div style="border: 1pt dotted; margin: 1em"
     79**Note:** Some web browsers (IE, Opera) cache CSS and !JavaScript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be sufficient.
     81Remove above note once #9936 is fixed.
     85=== 7. Steps specific to a given Trac version #VersionSpecificSteps
     87==== Upgrading from Trac 1.2 to 1.4 #to1.4
     89===== Python 2.6 no longer supported
     91Upgrade Python to 2.7, but not 3.0 or greater.
     93===== MySQL-python no longer supported
     95[ PyMySQL] is the supported MySQL database library, support for [ MySQL-python] has been removed.
     97===== Obsolete Plugins
     99Trac has added functionality equivalent to the following plugins:
     101* [ DynamicVariablesPlugin]: dynamic variables are autocompleted
     102* [ NavAddPlugin]: see TracNavigation
     103* [ FlexibleAssignToPlugin]: subclass `ConfigurableTicketWorkflow` and override `get_allowed_owners`
     104* [ TracMigratePlugin]: Use the `trac-admin` [TracAdmin#ChangingDatabaseBackend convert_db command]
     106The plugins should be removed when upgrading Trac to 1.4.
     108===== Jinja2 is the new template engine
     110Content is now generated by using the Jinja2 template
     111engine. You should verify that your plugins are
     112compatible with this change.
     114If you customized the Trac templates, or the `site.html`
     115template, you'll need to adapt that as well.
     116(TODO: expand...) See [#CustomizedTemplates]. Email [TracNotification#CustomizingContent notification templates] also need to
     117be adapted.
     119===== New permission policies for Wiki and Ticket realms
     121Since 1.3.2 there are new permission policies for the ticket and wiki systems. `DefaultTicketPolicy` allows an authenticated user with `TICKET_APPEND` or `TICKET_CHPROP` to modify the description of a ticket they reported. It also implements the pre-1.3.2 behavior of allowing users to edit their own ticket comments. [#Newpermissionspolicyforread-onlywikipages ReadonlyWikiPolicy], added in 1.1.2, is renamed to `DefaultWikiPolicy`. The new permission policies can be easily replaced with alternate implementations if the default behavior is not desired.
     123If `[trac] permission_policy` has the default value `ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy`, then `DefaultWikiPolicy, DefaultTicketPolicy` should be automatically appended to the list when upgrading the environment:
     126permission_policies = DefaultWikiPolicy,
     127 DefaultTicketPolicy,
     128 DefaultPermissionPolicy,
     129 LegacyAttachmentPolicy
     132If other permission policies are enabled, `trac.ini` will need to be edited to add `DefaultWikiPolicy, DefaultTicketPolicy` to `permission_policies`. See [wiki:TracFineGrainedPermissions#DefaultWikiPolicyandDefaultTicketPolicy] for additional details on the proper ordering.
     134===== Description field added to ticket enums #enum-description-field
     136The ticket enums now have a //description// field. An //ambiguous column name// error may be seen for reports that reference the `description` column of another table and join the `enum` table with that table (e.g. `ticket`, `component`). The reports {1}, {2}, {3}, {4}, {5}, {7}, and {8} are modified by an upgrade step to fix the issue, but the modification may not succeed if the default reports have been modified, in which case `upgrade` will output a message to the terminal instructing the user to modify the reports. User-created reports may also need to be modified.
     138Reports that display the error need to be modified to prefix the `description` column with the appropriate table name or alias. For example, if the `ticket` table is aliased as `t` (`ticket t` or `ticket AS t`), replace `description` with `t.description` if the report should use the ticket's `description` column.
     140===== Removed `<repostype>` and `<repospath>` arguments from `trac-admin` `initenv` command
     142The TracAdmin `initenv` command allowed the default repository to be specified using the third and fourth positional arguments of `initenv`:
     144initenv [<projectname> <db> [<repostype> <repospath>]]
     147The arguments were an artifact of Trac < 0.12, which only supported a single repository. Trac 0.12 and later supports multiple repositories, which can be specified at the time of environment creation using the `--inherit` and `--config` arguments. See the [TracEnvironment#SourceCodeRepository initenv documentation] for details on specifying source code repositories.
     149==== Upgrading from Trac 1.0 to 1.2 #to1.2
     151===== Python 2.5 no longer supported
     153Upgrade Python to at least 2.6 or 2.7, but not 3.0 or greater.
     155===== Obsolete Plugins
     157Trac has added functionality equivalent to the following plugins:
     158* [ AdminEnumListPlugin]
     159* [ AttachmentNotifyPlugin]: attachment notifications are sent in Trac 1.0.3 and later
     160* [ DateFieldPlugin]: see the **time** [TracTicketsCustomFields#AvailableFieldTypesandOptions custom field type]
     161* [ FlexibleReporterNotificationPlugin]: [trac:CookBook/Notification/Subscriptions custom subscribers] can be implemented in the new extensible notification system
     162* [ GroupBasedRedirectionPlugin]: the default handler can set as a user preference
     163* [ GroupingAssignToPlugin]: groups and permissions can be used in the [TracWorkflow#BasicTicketWorkflowCustomization set_owner] workflow attribute
     164* [ LinenoMacro]: see WikiProcessors#AvailableProcessors
     165* [ NeverNotifyUpdaterPlugin]: see [TracNotification#notification-subscriber-section notification subscribers]
     166* [ QueryUiAssistPlugin]: see TracQuery#Filters.
     167* [ TicketCreationStatusPlugin]: see [#NewWorkflowActions]
     169The plugins should be removed when upgrading Trac to 1.2.
     171===== New workflow actions #NewWorkflowActions
     173The ticket creation step is controlled with a workflow action. The default workflow has `create` and `create_and_assign` actions. The `create` action will always be added when upgrading the database. The `create_and_assign` action will be added if the workflow has an //assigned// state. You may want to edit your workflow after upgrading the database to customize the actions available on the //New Ticket// page.
     175===== New permissions policy for read-only wiki pages
     177Since 1.1.2 the read-only attribute of wiki pages is enabled and enforced only when `ReadonlyWikiPolicy` is in the list of active permission policies. If `[trac] permission_policy` has the default value `DefaultPermissionPolicy, LegacyAttachmentPolicy`, then `ReadonlyWikiPolicy` should be automatically appended to the list when upgrading the environment:
     180permission_policies = ReadonlyWikiPolicy,
     181 DefaultPermissionPolicy,
     182 LegacyAttachmentPolicy
     185If other permission policies are enabled, `trac.ini` will need to have `ReadonlyWikiPolicy` appended to the list of active `permission_policies`. See TracFineGrainedPermissions#ReadonlyWikiPolicy for additional details on the proper ordering.
     187===== Navigation Ordering Moved
     189The mainnav and metanav configuration ordering have
     190been moved from `[trac]` `mainnav` and `[trac]` `metanav` to the `[mainnav]` and `[metanav]` sections. The ordering is now specified using the `order` attribute as described in [TracNavigation#nav-order TracNavigation].
     192The new configuration values will be written to trac.ini on upgrade, preserving the navigation order for the environment. You may need to edit trac.ini
     193if you use a shared [TracIni#GlobalConfiguration global configuration].
     194For example, if you wish to specify the navigation ordering for several environments in `global.ini`, you'll
     195need to add the `[mainnav]` and `[metanav]` sections
     196in that file and delete those sections from each
     197environment's trac.ini.
     199==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     201===== Python 2.4 no longer supported
     203Upgrade Python to at least 2.5, but not 3.0.
     205===== Obsolete Plugins
     207Trac has added functionality equivalent to the following plugins:
     209* [ AnchorMacro]
     210* [ BatchModifyPlugin]
     211* [ GitPlugin]
     212* [ OverrideEditPlugin]
     213* [ ProgressMeterMacro]
     215The plugins should be removed when upgrading Trac to 1.0.
     217===== Subversion components not enabled by default for new installations
     219The 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:
     222tracopt.versioncontrol.svn.* = enabled
     225The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
     227===== Attachments migrated to new location #AttachmentsMigrated
     229Another step in the automatic upgrade will change the way the attachments are stored. There have been reports that the attachment migration [#AttachmentsNotMigrated sometimes fails], so it's extra important that you [TracBackup backup your environment].
     231In case the `attachments` directory contains some files which are //not// attachments, the last step of the migration to the new layout will not be completed: 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.
     233===== Behavior of `[ticket] default_owner` changed
     235Prior 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.
     237==== Upgrading from older versions of Trac #OlderVersions
     239For upgrades from versions older than Trac 0.12, refer first to [trac:wiki:0.12/TracUpgrade#SpecificVersions TracUpgrade for 0.12].
     241For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions TracUpgrade for 0.10].
     243== Known Issues
     245=== Customized Templates
     247Trac supports customization of its 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 customize the templates, be aware that you will need to repeat your changes on a copy of the new templates when you upgrade to a new release of Trac (even a minor one), as the templates will evolve. So keep a diff around.
     249The preferred way to perform TracInterfaceCustomization is a custom plugin doing client-side !JavaScript transformation of the generated output, as this is more robust in case of changes: we usually won't modify an element `id` or change its CSS `class`, and if we have to do so, this will be documented in the [trac:TracDev/ApiChanges] pages.
     251=== !ZipImportError
     253Due 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 to anticipate and bring your server down for maintenance before upgrading.
     254See [trac:#7014] for details.
     256=== Wiki Upgrade
     258`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.
     260=== Parent dir
     262If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
     264=== Attachments not migrated #AttachmentsNotMigrated
     266There have been reports that attachments are not [#AttachmentsMigrated migrated] when upgrading to Trac 1.0 or later. The cause of the issue has not yet been found. If you encounter this issue, see [ the FAQ] for a workaround and please report your findings to [trac:#11370].
     268== Related topics
     270=== Upgrading Python
     272Upgrading Python to a newer version will require reinstallation of Python packages: Trac itself of course, but also [TracInstall#Dependencies dependencies]. If you are using Subversion, you'll need to upgrade the [trac:TracSubversion Python bindings for SVN].