Edgewall Software

Changes between Initial Version and Version 1 of 1.2/TracUpgrade


Ignore:
Timestamp:
Oct 15, 2019, 6:33:02 AM (2 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 1.2/TracUpgrade

    v1 v1  
     1= Upgrade Instructions
     2[[TracGuideToc]]
     3[[TranslatedPages]]
     4[[PageOutline(2-4,,inline,unnumbered)]]
     5
     6== Instructions
     7
     8Typically, there are seven steps involved in upgrading to a newer version of Trac:
     9
     10=== 1. Bring your server off-line
     11
     12It 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].
     13
     14Although 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.
     15
     16=== 2. Update the Trac Code #UpdatetheTracCode
     17
     18Get the new version as described in TracInstall, or through your operating system package manager.
     19
     20If 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:
     21
     22{{{#!sh
     23easy_install --upgrade Trac
     24}}}
     25
     26You 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.
     27The location of the site-packages directory depends on the operating system and the location in which Python was installed. However, the following locations are typical:
     28 * on Linux: `/usr/lib/python2.X/site-packages`
     29 * on Windows: `C:\Python2.X\lib\site-packages`
     30 * on MacOSX: `/Library/Python/2.X/site-packages`
     31
     32You 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.
     33
     34=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
     35
     36Environment upgrades are not necessary for minor version releases unless otherwise noted.
     37
     38After 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]:
     39{{{#!sh
     40trac-admin /path/to/projenv upgrade
     41}}}
     42
     43This command will not have any effect if the environment is already up-to-date.
     44
     45Note that a backup of your database will be performed automatically prior to the upgrade. The backup will be saved in the location specified by `[trac]` `backup_dir`.
     46
     47=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
     48
     49By 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:
     50{{{#!sh
     51trac-admin /path/to/projenv wiki upgrade
     52}}}
     53
     54Note that this procedure will leave your `WikiStart` page intact.
     55
     56=== 5. Refresh static resources
     57
     58If 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 same command]:
     59{{{#!sh
     60trac-admin /path/to/env deploy /deploy/path
     61}}}
     62
     63This will extract static resources and CGI scripts (`trac.wsgi`, etc) from the new Trac version and plugins into `/deploy/path`.
     64
     65{{{#!div style="border: 1pt dotted; margin: 1em"
     66**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 enough.
     67{{{#!comment
     68Remove above note once #9936 is fixed.
     69}}}
     70}}}
     71
     72=== 6. Steps specific to a given Trac version
     73
     74==== Upgrading from Trac 1.0 to 1.2 #to1.2
     75
     76===== Python 2.5 no longer supported
     77
     78Upgrade Python to at least 2.6 or 2.7, but not 3.0 or greater.
     79
     80===== Obsolete Plugins
     81
     82Trac has added functionality equivalent to the following plugins:
     83* [https://trac-hacks.org/wiki/AdminEnumListPlugin AdminEnumListPlugin]
     84* [https://trac-hacks.org/wiki/DateFieldPlugin DateFieldPlugin]: see the **time** [TracTicketsCustomFields#AvailableFieldTypesandOptions custom field type]
     85* [https://trac-hacks.org/wiki/GroupBasedRedirectionPlugin GroupBasedRedirectionPlugin]: the default handler can set as a user preference.
     86* [https://trac-hacks.org/wiki/LinenoMacro LinenoMacro]: see WikiProcessors#AvailableProcessors
     87* [https://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin NeverNotifyUpdaterPlugin]: see [TracNotification#notification-subscriber-section notification subscribers]
     88* [https://trac-hacks.org/wiki/QueryUiAssistPlugin QueryUiAssistPlugin]: see TracQuery#Filters.
     89* [https://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin]: see [#NewWorkflowActions]
     90
     91The plugins should be removed when upgrading Trac to 1.2.
     92
     93===== New workflow actions #NewWorkflowActions
     94
     95The ticket creation step is controlled with a [TracWorkflow#TicketCreateAction 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.
     96
     97===== New permissions policy for read-only wiki pages
     98
     99Since 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:
     100{{{#!ini
     101[trac]
     102permission_policies = ReadonlyWikiPolicy,
     103 DefaultPermissionPolicy,
     104 LegacyAttachmentPolicy
     105}}}
     106
     107If 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.
     108
     109==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     110
     111===== Python 2.4 no longer supported
     112
     113Upgrade Python to at least 2.5, but not 3.0.
     114
     115===== Obsolete Plugins
     116
     117Trac has added functionality equivalent to the following plugins:
     118
     119* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
     120* [https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     121* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
     122
     123The plugins should be removed when upgrading Trac to 1.0.
     124
     125===== Subversion components not enabled by default for new installations
     126
     127The 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:
     128{{{#!ini
     129[components]
     130tracopt.versioncontrol.svn.* = enabled
     131}}}
     132
     133The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
     134
     135===== Attachments migrated to new location
     136
     137Another 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.
     138
     139===== Behavior of `[ticket] default_owner` changed
     140
     141Prior 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.
     142
     143==== Upgrading from Trac 0.11 to Trac 0.12
     144
     145===== Python 2.3 no longer supported
     146
     147The minimum supported version of Python is now 2.4.
     148
     149===== SQLite v3.x required
     150
     151SQLite 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.
     152
     153===== [trac:PySqlite] 2 required
     154
     155[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
     156
     157===== Obsolete Plugins
     158
     159Trac has added functionality equivalent to the following plugins:
     160
     161* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
     162* [https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     163* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
     164* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
     165* [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter`
     166* [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories
     167* [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole]
     168* [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1)
     169
     170The plugins should be removed when upgrading Trac to 0.12.
     171
     172===== Multiple Repository Support
     173
     174The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
     175
     176This 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.
     177
     178===== Resynchronize the Trac Environment Against the Source Code Repository
     179
     180Each [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:
     181
     182{{{#!sh
     183trac-admin /path/to/projenv repository resync '*'
     184}}}
     185
     186===== Improved repository synchronization
     187
     188In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
     189
     190While you can keep the same synchronization as in 0.11 adding the post-commit hook as outlined in TracRepositoryAdmin#Synchronization and TracRepositoryAdmin#ExplicitSync will allow more efficient synchronization and is more or less required for multiple repositories.
     191
     192Note 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.
     193
     194===== Authz permission checking
     195
     196The 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.
     197
     198===== Microsecond timestamps
     199
     200All 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.
     201
     202==== Upgrading from Trac 0.10 to Trac 0.11
     203
     204===== Site Templates and Styles
     205
     206The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
     207
     208If 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.
     209
     210===== Trac Macros, Plugins
     211
     212The 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.
     213
     214===== For FCGI/WSGI/CGI users
     215
     216For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
     217{{{#!sh
     218trac-admin /path/to/env deploy /deploy/directory/path
     219}}}
     220
     221This 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.
     222
     223===== Web Admin plugin integrated
     224
     225If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     226
     227===== New Default Configurable Workflow
     228
     229When 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:
     230
     231{{{#!Workflow width=500 height=240
     232leave = * -> *
     233leave.operations = leave_status
     234leave.default = 1
     235accept = new -> assigned
     236accept.permissions = TICKET_MODIFY
     237accept.operations = set_owner_to_self
     238resolve = new,assigned,reopened -> closed
     239resolve.permissions = TICKET_MODIFY
     240resolve.operations = set_resolution
     241reassign = new,assigned,reopened -> new
     242reassign.permissions = TICKET_MODIFY
     243reassign.operations = set_owner
     244reopen = closed -> reopened
     245reopen.permissions = TICKET_CREATE
     246reopen.operations = del_resolution
     247}}}
     248
     249There 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:branches/1.2-stable/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.
     250
     251=== 7. Restart the Web Server #RestarttheWebServer
     252
     253If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
     254
     255== Known Issues
     256
     257=== Customized Templates
     258
     259Trac 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.
     260
     261The 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 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.
     262
     263=== !ZipImportError
     264
     265Due 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.
     266See [trac:#7014] for details.
     267
     268=== Wiki Upgrade
     269
     270`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.
     271
     272=== Trac database upgrade
     273
     274A 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].
     275
     276=== Parent dir
     277
     278If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
     279
     280== Related topics
     281
     282=== Upgrading Python
     283
     284Upgrading Python to a newer version will require reinstallation of Python packages: Trac itself of course, but also [https://pypi.org/project/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.
     285
     286==== Windows and Python 2.6
     287
     288If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [https://alagazam.net/ Alagazam], which has the Python bindings readily available, see [trac:TracSubversion]. That package works without tweaking.
     289
     290=== Changing Database Backend
     291
     292The [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.
     293
     294=== Upgrading from older versions of Trac #OlderVersions
     295
     296For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
     297
     298-----
     299See also: TracGuide, TracInstall