Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
Jul 15, 2019, 2:18:56 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v1 v2  
    1 = Upgrade Instructions =
     1= Upgrade Instructions
    22[[TracGuideToc]]
    3 
    4 == Instructions ==
     3[[PageOutline(2-4,,inline,unnumbered)]]
     4
     5== Instructions
    56
    67Typically, there are seven steps involved in upgrading to a newer version of Trac:
    78
    8 === 1. Update the Trac Code === #UpdatetheTracCode
    9 
    10 Get the new version as described in TracInstall, or your operating system specific procedure.
    11 
    12 If you already have a 0.11 version of Trac installed via `easy_install`, it might be the easiest to use it also to upgrade you Trac installation.
    13 
    14 {{{
    15 # easy_install --upgrade Trac==0.12b1
    16 }}}
    17 (once beta1 is released, that is)
    18 
    19 If you do a manual (not operating system specific) upgrade, you should also stop any running Trac server before the installation. Doing "hot" upgrades is not advised, especially not on Windows ([trac:ticket:7625 #7265]).
    20 
    21 You 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 .eggs from former versions.
    22 The location of the site-packages directory depends on the operating system, and the location in which Python was installed. However, the following locations are common:
     9=== 1. Bring your server off-line
     10
     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}}}
     24
     25You 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.
     26The 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:
    2327 * on Linux: `/usr/lib/python2.X/site-packages`
    2428 * on Windows: `C:\Python2.X\lib\site-packages`
    2529 * on MacOSX: `/Library/Python/2.X/site-packages`
    2630
    27 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).
    28 
    29 This cleanup is not mandatory, but it makes it easier to troubleshoot issues later on, as you won't waste your time looking at code or templates from a previous release that are not being used anymore... As usual, make a backup before actually deleting things.
    30 
    31 === 2. 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
    3234
    3335Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3436
    3537After 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]:
    36 {{{
     38{{{#!sh
    3739trac-admin /path/to/projenv upgrade
    3840}}}
    3941
    40 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.
    4143
    4244Note that a backup of your database will be performed automatically prior to the upgrade.
    43 This feature is relatively new for the PostgreSQL or MySQL database backends, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:
    44 {{{
     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
    4547trac-admin /path/to/projenv upgrade --no-backup
    4648}}}
    4749
    48 === 3. Update the Trac Documentation === #UpdatetheTracDocumentation
    49 
    50 Every [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, [TracAdmin trac-admin] provides a command to upgrade the documentation:
    51 {{{
     50=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
     51
     52By 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{{{#!sh
    5254trac-admin /path/to/projenv wiki upgrade
    5355}}}
    5456
    55 Note that this procedure will of course leave your `WikiStart` page intact.
    56 
    57 === 4. Resynchronize the Trac Environment Against the Source Code Repository ===
    58 
    59 Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[http://trac.edgewall.org/ticket/6120 No changeset ??? in the repository]" while browsing the source through the Trac interface:
    60 
    61 {{{
     57Note that this procedure will leave your `WikiStart` page intact.
     58
     59=== 5. Refresh static resources
     60
     61If 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{{{#!sh
     63trac-admin /path/to/env deploy /deploy/path
     64}}}
     65
     66This will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
     67
     68Some 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.
     69{{{#!comment
     70Remove above note once #9936 is fixed.
     71}}}
     72
     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
     114Upgrade Python to at least 2.5, but not 3.0.
     115
     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
     126===== Subversion components not enabled by default for new installations
     127
     128The 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:
     129{{{#!ini
     130[components]
     131tracopt.versioncontrol.svn.* = enabled
     132}}}
     133
     134The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
     135
     136===== Attachments migrated to new location
     137
     138Another 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.
     139
     140===== Behavior of `[ticket] default_owner` changed
     141
     142Prior 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.
     143
     144==== Upgrading from Trac 0.11 to Trac 0.12
     145
     146===== Python 2.3 no longer supported
     147
     148The minimum supported version of Python is now 2.4.
     149
     150===== SQLite v3.x required
     151
     152SQLite 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.
     153
     154===== [trac:PySqlite] 2 required
     155
     156[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
     157
     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
     175The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
     176
     177This 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.
     178
     179===== Resynchronize the Trac Environment Against the Source Code Repository
     180
     181Each [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:
     182
     183{{{#!sh
    62184trac-admin /path/to/projenv repository resync '*'
    63185}}}
    64186
    65 === 5. Refresh static resources ===
    66 
    67 If you've setup web server to give out static resources directly (accessed using /chrome/ URL) then you need to refresh them using the same command:
    68 {{{
    69 trac-admin /path/to/env deploy /deploy/path
    70 }}}
    71 this will extract static resources and CGI scripts (trac.wsgi, etc) from new Trac version and its plugins into `/deploy/path`.
    72 
    73 Some web browsers cache the CSS and Javascript file in a strong way, so you'll perhaps need to refresh the cache of the browsers by a force reload (and tell your users to do so!).
    74 
    75 === 6. Steps specific to a given Trac version  ===
    76 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
    77 ===== Python 2.3 no longer supported =====
    78 The minimum supported version of python is now 2.4
    79 
    80 ===== SQLite v3.x required =====
    81 SQLite v2.x is no longer supported, if you happen to still use a Trac database using this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details.
    82 
    83 ===== Multiple Repository Support =====
    84 If you plan to add more repositories to your Trac instance, as this is now possible with the newly introduced multiple repository support, please refer to TracRepositoryAdmin#Migration.
    85 
    86 This can be of interest even if you only have one repository, as there's now a way to avoid the potentially costly resync check at every request.
    87 
    88 ===== Improved repository synchronization =====
    89 In addition to supporting multiple repositories, a new more efficient method for synchronizing Trac and your repositories was implemented.
     187===== Improved repository synchronization
     188
     189In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    90190
    91191While 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.
    92192
    93 Note 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, 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.
    94 
    95 ==== Upgrading from Trac 0.10 to Trac 0.11 ====
    96 ===== Site Templates and Styles =====
     193Note 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.
     194
     195===== Authz permission checking
     196
     197The 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.
     198
     199===== Microsecond timestamps
     200
     201All 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.
     202
     203==== Upgrading from Trac 0.10 to Trac 0.11
     204
     205===== Site Templates and Styles
     206
    97207The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    98208
    99 If you are using custom CSS styles 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.
    100 
    101 ===== Trac Macros, Plugins =====
    102 The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of [trac:ClearSilver 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.
    103 
    104 ===== For FCGI/WSGI/CGI users =====
     209If 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.
     210
     211===== Trac Macros, Plugins
     212
     213The 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.
     214
     215===== For FCGI/WSGI/CGI users
     216
    105217For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    106 {{{
     218{{{#!sh
    107219trac-admin /path/to/env deploy /deploy/directory/path
    108220}}}
    … …  
    110222This 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.
    111223
    112 ===== Web Admin plugin integrated =====
    113 If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    114 
    115 === 7. Restart the Web Server === #RestarttheWebServer
     224===== Web Admin plugin integrated
     225
     226If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     227
     228===== New Default Configurable Workflow
     229
     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:
     231
     232{{{#!Workflow width=500 height=240
     233leave = * -> *
     234leave.operations = leave_status
     235leave.default = 1
     236accept = new -> assigned
     237accept.permissions = TICKET_MODIFY
     238accept.operations = set_owner_to_self
     239resolve = new,assigned,reopened -> closed
     240resolve.permissions = TICKET_MODIFY
     241resolve.operations = set_resolution
     242reassign = new,assigned,reopened -> new
     243reassign.permissions = TICKET_MODIFY
     244reassign.operations = set_owner
     245reopen = closed -> reopened
     246reopen.permissions = TICKET_CREATE
     247reopen.operations = del_resolution
     248}}}
     249
     250There 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.
     251
     252=== 7. Restart the Web Server #RestarttheWebServer
    116253
    117254If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    118255
    119 == Known Issues ==
    120 
    121 === parent dir ===
    122 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
    123 
    124 === Wiki Upgrade ===
     256== Known Issues
     257
     258=== Customized Templates
     259
     260Trac 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.
     261
     262The 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.
     263
     264=== !ZipImportError
     265
     266Due 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.
     267See [trac:#7014] for details.
     268
     269=== Wiki Upgrade
     270
    125271`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.
    126272
    127 
    128 == Changing Database Backend ==
    129 === SQLite to PostgreSQL ===
    130 
    131 The [http://trac-hacks.org/wiki/SqliteToPgScript sqlite2pg] script on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating a SQLite database to a PostgreSQL database
    132 
    133 == Older Versions ==
     273=== Trac database upgrade
     274
     275A 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].
     276
     277=== Parent dir
     278
     279If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
     280
     281== Related topics
     282
     283=== Upgrading Python
     284
     285Upgrading 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.
     286
     287==== Windows and Python 2.6
     288
     289If 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.
     290
     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
    134296
    135297For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].