Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
12/03/16 22:48:27 (3 years 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
    14 
    15 Get the new version as described in TracInstall, or your operating system specific procedure.
    16 
    17 If 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:
    18 
    19 {{{
    20 # easy_install --upgrade Trac==1.0
    21 }}}
    22 
    23 If 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]).
     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
     16
     17Get the new version as described in TracInstall, or through your operating system package manager.
     18
     19If you already an earlier version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:
     20
     21{{{#!sh
     22easy_install --upgrade Trac==1.2
     23}}}
    2424
    2525You 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.
     
    2929 * on MacOSX: `/Library/Python/2.X/site-packages`
    3030
    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. 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.
    32 
    33 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     31You may also want to remove the directory in which your static resources are [TracInstall#cgi-bin deployed]. 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.
     32
     33=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    3434
    3535Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3636
    3737After 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 {{{
     38{{{#!sh
    3939trac-admin /path/to/projenv upgrade
    4040}}}
    4141
    42 This command will do nothing if the environment is already up-to-date.
     42This command will not have any effect if the environment is already up-to-date.
    4343
    4444Note 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 {{{
     45This 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:
     46{{{#!sh
    4747trac-admin /path/to/projenv upgrade --no-backup
    4848}}}
     
    5151
    5252By 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 {{{
     53{{{#!sh
    5454trac-admin /path/to/projenv wiki upgrade
    5555}}}
     
    5757Note that this procedure will leave your `WikiStart` page intact.
    5858
    59 === 5. Refresh static resources ===
     59=== 5. Refresh static resources
    6060
    6161If 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 {{{
     62{{{#!sh
    6363trac-admin /path/to/env deploy /deploy/path
    6464}}}
    65 this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
     65
     66This will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    6667
    6768Some 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.
     
    7071}}}
    7172
    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 =====
     73=== 6. Steps specific to a given Trac version
     74
     75==== Upgrading from Trac 1.0 to 1.2 #to1.2
     76
     77===== Python 2.5 no longer supported
     78
     79Upgrade Python to at least 2.6 or 2.7, but not 3.0 or greater.
     80
     81===== Obsolete Plugins
     82
     83Trac has added functionality equivalent to the following plugins:
     84* [https://trac-hacks.org/wiki/AdminEnumListPlugin AdminEnumListPlugin]
     85* [https://trac-hacks.org/wiki/DateFieldPlugin DateFieldPlugin]: see the **time** [TracTicketsCustomFields#AvailableFieldTypesandOptions custom field type]
     86* [https://trac-hacks.org/wiki/GroupBasedRedirectionPlugin GroupBasedRedirectionPlugin]: the default handler can set as a user preference.
     87* [https://trac-hacks.org/wiki/LinenoMacro LinenoMacro]: see WikiProcessors#AvailableProcessors
     88* [https://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin NeverNotifyUpdaterPlugin]: see [TracNotification#notification-subscriber-section notification subscribers]
     89* [https://trac-hacks.org/wiki/QueryUiAssistPlugin QueryUiAssistPlugin]: see TracQuery#Filters.
     90* [https://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin]: see [#NewWorkflowActions]
     91
     92The plugins should be removed when upgrading Trac to 1.2.
     93
     94===== New workflow actions #NewWorkflowActions
     95
     96The 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.
     97
     98===== New permissions policy for read-only wiki pages
     99
     100Since 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:
     101{{{#!ini
     102[trac]
     103permission_policies = ReadonlyWikiPolicy,
     104 DefaultPermissionPolicy,
     105 LegacyAttachmentPolicy
     106}}}
     107
     108If 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.
     109
     110==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     111
     112===== Python 2.4 no longer supported
     113
    77114Upgrade Python to at least 2.5, but not 3.0.
    78115
     116===== Obsolete Plugins
     117
     118Trac has added functionality equivalent to the following plugins:
     119
     120* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
     121* ​[https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     122* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
     123
     124The plugins should be removed when upgrading Trac to 1.0.
     125
    79126===== Subversion components not enabled by default for new installations
     127
    80128The 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 {{{
     129{{{#!ini
    82130[components]
    83131tracopt.versioncontrol.svn.* = enabled
    84132}}}
     133
    85134The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    86135
    87136===== Attachments migrated to new location
     137
    88138Another 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.
    89139
    90140===== Behavior of `[ticket] default_owner` changed
     141
    91142Prior 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.
    92143
    93 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
    94 
    95 ===== Python 2.3 no longer supported =====
     144==== Upgrading from Trac 0.11 to Trac 0.12
     145
     146===== Python 2.3 no longer supported
     147
    96148The minimum supported version of Python is now 2.4.
    97149
    98 ===== SQLite v3.x required =====
     150===== SQLite v3.x required
     151
    99152SQLite 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.
    100153
    101 ===== [trac:PySqlite] 2 required =====
     154===== [trac:PySqlite] 2 required
     155
    102156[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    103157
    104 ===== Multiple Repository Support =====
     158===== Obsolete Plugins
     159
     160Trac has added functionality equivalent to the following plugins:
     161
     162* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
     163* ​[https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     164* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
     165* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
     166* [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter`
     167* [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories
     168* [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole]
     169* [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1)
     170
     171The plugins should be removed when upgrading Trac to 0.12.
     172
     173===== Multiple Repository Support
     174
    105175The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    106176
    107177This 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.
    108178
    109 ===== Resynchronize the Trac Environment Against the Source Code Repository =====
     179===== Resynchronize the Trac Environment Against the Source Code Repository
    110180
    111181Each [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:
    112182
    113 {{{
     183{{{#!sh
    114184trac-admin /path/to/projenv repository resync '*'
    115185}}}
    116186
    117 ===== Improved repository synchronization =====
     187===== Improved repository synchronization
     188
    118189In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    119190
     
    122193Note 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.
    123194
    124 ===== Authz permission checking =====
     195===== Authz permission checking
     196
    125197The 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.
    126198
    127 ===== Microsecond timestamps =====
     199===== Microsecond timestamps
     200
    128201All 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.
    129202
    130 ==== Upgrading from Trac 0.10 to Trac 0.11 ====
    131 ===== Site Templates and Styles =====
     203==== Upgrading from Trac 0.10 to Trac 0.11
     204
     205===== Site Templates and Styles
     206
    132207The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    133208
    134209If 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.
    135210
    136 ===== Trac Macros, Plugins =====
     211===== Trac Macros, Plugins
     212
    137213The 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.
    138214
    139 ===== For FCGI/WSGI/CGI users =====
     215===== For FCGI/WSGI/CGI users
     216
    140217For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    141 {{{
     218{{{#!sh
    142219trac-admin /path/to/env deploy /deploy/directory/path
    143220}}}
     
    145222This 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.
    146223
    147 ===== Web Admin plugin integrated =====
     224===== Web Admin plugin integrated
     225
    148226If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    149227
    150228===== New Default Configurable Workflow
    151229
    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:
     230When 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:
    155231
    156232{{{#!Workflow width=500 height=240
     
    174250There 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.
    175251
    176 === 7. Restart the Web Server === #RestarttheWebServer
     252=== 7. Restart the Web Server #RestarttheWebServer
    177253
    178254If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    179255
    180 == Known Issues ==
     256== Known Issues
    181257
    182258=== Customized Templates
     
    186262The 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.
    187263
    188 === !ZipImportError ===
     264=== !ZipImportError
    189265
    190266Due 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.
    191267See [trac:#7014] for details.
    192268
    193 === Wiki Upgrade ===
     269=== Wiki Upgrade
     270
    194271`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.
    195272
    196 === Trac database upgrade ===
     273=== Trac database upgrade
    197274
    198275A 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].
    199276
    200 === Parent dir ===
     277=== Parent dir
     278
    201279If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    202280
    203281== Related topics
    204282
    205 === Upgrading Python ===
     283=== Upgrading Python
    206284
    207285Upgrading 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.
    208286
    209 ==== Windows and Python 2.6 ====
     287==== Windows and Python 2.6
    210288
    211289If 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.
    212290
    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
     291=== Changing Database Backend
     292
     293The [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.
     294
     295=== Upgrading from older versions of Trac #OlderVersions
    218296
    219297For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].