Changes between Version 3 and Version 4 of TracUpgrade


Ignore:
Timestamp:
02/01/17 00:39:17 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v3 v4  
    1515=== 2. Update the Trac Code #UpdatetheTracCode
    1616
    17 Get the new version as described in TracInstall, or your operating system specific procedure.
    18 
    19 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:
    20 
    21 {{{#!sh
    22 easy_install --upgrade Trac==1.0
    23 }}}
    24 
    25 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]).
     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}}}
    2624
    2725You 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.
     
    3129 * on MacOSX: `/Library/Python/2.X/site-packages`
    3230
    33 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.
     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.
    3432
    3533=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
     
    4240}}}
    4341
    44 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.
    4543
    4644Note that a backup of your database will be performed automatically prior to the upgrade.
    47 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:
     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:
    4846{{{#!sh
    4947trac-admin /path/to/projenv upgrade --no-backup
     
    6563trac-admin /path/to/env deploy /deploy/path
    6664}}}
    67 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`.
    6867
    6968Some 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.
     
    7473=== 6. Steps specific to a given Trac version
    7574
     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
    76110==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
    77111
    78112===== Python 2.4 no longer supported
     113
    79114Upgrade Python to at least 2.5, but not 3.0.
    80115
     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
    81126===== Subversion components not enabled by default for new installations
     127
    82128The 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:
    83129{{{#!ini
     
    85131tracopt.versioncontrol.svn.* = enabled
    86132}}}
     133
    87134The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    88135
    89136===== Attachments migrated to new location
     137
    90138Another 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.
    91139
    92140===== Behavior of `[ticket] default_owner` changed
     141
    93142Prior 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.
    94143
     
    96145
    97146===== Python 2.3 no longer supported
     147
    98148The minimum supported version of Python is now 2.4.
    99149
    100150===== SQLite v3.x required
     151
    101152SQLite 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.
    102153
    103154===== [trac:PySqlite] 2 required
     155
    104156[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    105157
     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
    106173===== Multiple Repository Support
     174
    107175The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    108176
     
    118186
    119187===== Improved repository synchronization
     188
    120189In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    121190
     
    125194
    126195===== Authz permission checking
     196
    127197The 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.
    128198
    129199===== Microsecond timestamps
     200
    130201All 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.
    131202
    132203==== Upgrading from Trac 0.10 to Trac 0.11
     204
    133205===== Site Templates and Styles
     206
    134207The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    135208
     
    137210
    138211===== Trac Macros, Plugins
     212
    139213The 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.
    140214
    141215===== For FCGI/WSGI/CGI users
     216
    142217For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    143218{{{#!sh
     
    148223
    149224===== Web Admin plugin integrated
     225
    150226If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    151227
    152228===== New Default Configurable Workflow
    153229
    154 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.
    155 
    156 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:
    157231
    158232{{{#!Workflow width=500 height=240
     
    176250There 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.
    177251
    178 ===== Global Configuration
    179 In 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.
    180 
    181252=== 7. Restart the Web Server #RestarttheWebServer
    182253
     
    197268
    198269=== Wiki Upgrade
     270
    199271`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.
    200272
     
    204276
    205277=== Parent dir
     278
    206279If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    207280
     
    218291=== Changing Database Backend
    219292
    220 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.
     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.
    221294
    222295=== Upgrading from older versions of Trac #OlderVersions