Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
May 2, 2019, 9:45:05 AM (14 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    1515=== 2. Update the Trac Code #UpdatetheTracCode
    1616
    17 Get the new version as described in TracInstall, or through your operating system package manager.
    18 
    19 If 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
    22 easy_install --upgrade Trac==1.2
    23 }}}
     17Get the new version as described in TracInstall, or your operating system specific procedure.
     18
     19If 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
     22easy_install --upgrade Trac==1.0
     23}}}
     24
     25If 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]).
    2426
    2527You 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.
     
    2931 * on MacOSX: `/Library/Python/2.X/site-packages`
    3032
    31 You 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.
     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.
    3234
    3335=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
     
    4042}}}
    4143
    42 This command will not have any effect if the environment is already up-to-date.
     44This command will do nothing 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:
     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, run:
    4648{{{#!sh
    4749trac-admin /path/to/projenv upgrade --no-backup
     
    6365trac-admin /path/to/env deploy /deploy/path
    6466}}}
    65 
    66 This will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
     67this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    6768
    6869Some 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.
     
    7374=== 6. Steps specific to a given Trac version
    7475
    75 ==== Upgrading from Trac 1.0 to 1.2 #to1.2
    76 
    77 ===== Python 2.5 no longer supported
    78 
    79 Upgrade Python to at least 2.6 or 2.7, but not 3.0 or greater.
    80 
    81 ===== Obsolete Plugins
    82 
    83 Trac 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 
    92 The plugins should be removed when upgrading Trac to 1.2.
    93 
    94 ===== New workflow actions #NewWorkflowActions
    95 
    96 The 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 
    100 Since 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]
    103 permission_policies = ReadonlyWikiPolicy,
    104  DefaultPermissionPolicy,
    105  LegacyAttachmentPolicy
    106 }}}
    107 
    108 If 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 
    11076==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
    11177
    11278===== Python 2.4 no longer supported
    113 
    11479Upgrade Python to at least 2.5, but not 3.0.
    11580
     
    12590
    12691===== Subversion components not enabled by default for new installations
    127 
    12892The 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:
    12993{{{#!ini
     
    13195tracopt.versioncontrol.svn.* = enabled
    13296}}}
    133 
    13497The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    13598
    13699===== Attachments migrated to new location
    137 
    138100Another 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.
    139101
    140102===== Behavior of `[ticket] default_owner` changed
    141 
    142103Prior 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.
    143104
     
    145106
    146107===== Python 2.3 no longer supported
    147 
    148108The minimum supported version of Python is now 2.4.
    149109
    150110===== SQLite v3.x required
    151 
    152111SQLite 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.
    153112
    154113===== [trac:PySqlite] 2 required
    155 
    156114[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    157115
     
    166124* [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter`
    167125* [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories
    168 * [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole]
     126* [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see WikiCreole
    169127* [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1)
    170128
     
    172130
    173131===== Multiple Repository Support
    174 
    175132The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    176133
     
    186143
    187144===== Improved repository synchronization
    188 
    189145In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    190146
     
    194150
    195151===== Authz permission checking
    196 
    197152The 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.
    198153
    199154===== Microsecond timestamps
    200 
    201155All 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.
    202156
    203157==== Upgrading from Trac 0.10 to Trac 0.11
    204 
    205158===== Site Templates and Styles
    206 
    207159The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    208160
     
    210162
    211163===== Trac Macros, Plugins
    212 
    213164The 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.
    214165
    215166===== For FCGI/WSGI/CGI users
    216 
    217167For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    218168{{{#!sh
     
    223173
    224174===== Web Admin plugin integrated
    225 
    226175If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    227176
    228177===== New Default Configurable Workflow
    229178
    230 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:
     179When 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.
     180
     181Graphically, that looks like this:
    231182
    232183{{{#!Workflow width=500 height=240
     
    250201There 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.
    251202
     203===== Global Configuration
     204In 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.
     205
    252206=== 7. Restart the Web Server #RestarttheWebServer
    253207
     
    268222
    269223=== Wiki Upgrade
    270 
    271224`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.
    272225
     
    276229
    277230=== Parent dir
    278 
    279231If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    280232
     
    291243=== Changing Database Backend
    292244
    293 The [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.
     245The [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.
    294246
    295247=== Upgrading from older versions of Trac #OlderVersions