Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
9 Apr 2015, 12:29:59 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    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
     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
    1416
    1517Get the new version as described in TracInstall, or your operating system specific procedure.
     
    1719If 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:
    1820
    19 {{{
    20 # easy_install --upgrade Trac==1.0
     21{{{#!sh
     22easy_install --upgrade Trac==1.0
    2123}}}
    2224
     
    3133You 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
    33 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     35=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    3436
    3537Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3638
    3739After 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 {{{
     40{{{#!sh
    3941trac-admin /path/to/projenv upgrade
    4042}}}
     
    4446Note that a backup of your database will be performed automatically prior to the upgrade.
    4547This 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 {{{
     48{{{#!sh
    4749trac-admin /path/to/projenv upgrade --no-backup
    4850}}}
     
    5153
    5254By 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 {{{
     55{{{#!sh
    5456trac-admin /path/to/projenv wiki upgrade
    5557}}}
     
    5759Note that this procedure will leave your `WikiStart` page intact.
    5860
    59 === 5. Refresh static resources ===
     61=== 5. Refresh static resources
    6062
    6163If 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 {{{
     64{{{#!sh
    6365trac-admin /path/to/env deploy /deploy/path
    6466}}}
     
    7072}}}
    7173
    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 =====
     74=== 6. Steps specific to a given Trac version
     75
     76==== Upgrading from Trac 1.0 to 1.1.x #to1.1.x
     77
     78===== Python 2.5 no longer supported
     79Upgrade Python to at least 2.6, but not 3.0.
     80
     81===== New workflow actions
     82
     83The ticket creation step is now 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.
     84
     85===== New permissions policy for read-only wiki pages
     86Since 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:
     87{{{#!ini
     88[trac]
     89permission_policies = ReadonlyWikiPolicy,
     90 DefaultPermissionPolicy,
     91 LegacyAttachmentPolicy
     92}}}
     93If other permission policies are enabled, //trac.ini// will need to be edited to append `ReadonlyWikiPolicy` to the list of active `permission_policies`. See TracFineGrainedPermissions#ReadonlyWikiPolicy for additional details on the proper ordering.
     94
     95==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     96
     97===== Python 2.4 no longer supported
    7798Upgrade Python to at least 2.5, but not 3.0.
    7899
    79100===== Subversion components not enabled by default for new installations
    80101The 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 {{{
     102{{{#!ini
    82103[components]
    83104tracopt.versioncontrol.svn.* = enabled
     
    91112Prior 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.
    92113
    93 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
    94 
    95 ===== Python 2.3 no longer supported =====
     114==== Upgrading from Trac 0.11 to Trac 0.12
     115
     116===== Python 2.3 no longer supported
    96117The minimum supported version of Python is now 2.4.
    97118
    98 ===== SQLite v3.x required =====
     119===== SQLite v3.x required
    99120SQLite 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.
    100121
    101 ===== PySqlite 2 required =====
    102 PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    103 
    104 ===== Multiple Repository Support =====
     122===== [trac:PySqlite] 2 required
     123[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
     124
     125===== Multiple Repository Support
    105126The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    106127
    107128This 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.
    108129
    109 ===== Resynchronize the Trac Environment Against the Source Code Repository =====
     130===== Resynchronize the Trac Environment Against the Source Code Repository
    110131
    111132Each [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:
    112133
    113 {{{
     134{{{#!sh
    114135trac-admin /path/to/projenv repository resync '*'
    115136}}}
    116137
    117 ===== Improved repository synchronization =====
     138===== Improved repository synchronization
    118139In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    119140
     
    122143Note 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.
    123144
    124 ===== Authz permission checking =====
     145===== Authz permission checking
    125146The 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.
    126147
    127 ===== Microsecond timestamps =====
     148===== Microsecond timestamps
    128149All 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.
    129150
    130 ==== Upgrading from Trac 0.10 to Trac 0.11 ====
    131 ===== Site Templates and Styles =====
     151==== Upgrading from Trac 0.10 to Trac 0.11
     152===== Site Templates and Styles
    132153The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    133154
    134155If 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.
    135156
    136 ===== Trac Macros, Plugins =====
     157===== Trac Macros, Plugins
    137158The 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.
    138159
    139 ===== For FCGI/WSGI/CGI users =====
     160===== For FCGI/WSGI/CGI users
    140161For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    141 {{{
     162{{{#!sh
    142163trac-admin /path/to/env deploy /deploy/directory/path
    143164}}}
     
    145166This 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.
    146167
    147 ===== Web Admin plugin integrated =====
    148 If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     168===== Web Admin plugin integrated
     169If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    149170
    150171===== New Default Configurable Workflow
     
    174195There 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.
    175196
    176 === 7. Restart the Web Server === #RestarttheWebServer
     197=== 7. Restart the Web Server #RestarttheWebServer
    177198
    178199If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    179200
    180 == Known Issues ==
     201== Known Issues
    181202
    182203=== Customized Templates
     
    184205Trac 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.
    185206
    186 The 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 TracDev/ApiChanges pages.
    187 
    188 === !ZipImportError ===
     207The 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.
     208
     209=== !ZipImportError
    189210
    190211Due 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.
    191212See [trac:#7014] for details.
    192213
    193 === Wiki Upgrade ===
     214=== Wiki Upgrade
    194215`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.
    195216
    196 === Trac database upgrade ===
    197 
    198 A known issue in some versions of 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].
    199 
    200 === Parent dir ===
     217=== Trac database upgrade
     218
     219A 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].
     220
     221=== Parent dir
    201222If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    202223
    203224== Related topics
    204225
    205 === Upgrading Python ===
     226=== Upgrading Python
    206227
    207228Upgrading 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.
    208229
    209 ==== Windows and Python 2.6 ====
    210 
    211 If 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 TracSubversion. That package works without tweaking.
    212 
    213 === Changing Database Backend ===
     230==== Windows and Python 2.6
     231
     232If 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.
     233
     234=== Changing Database Backend
    214235
    215236The [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.
    216237
    217 === Upgrading from older versions of Trac === #OlderVersions
     238=== Upgrading from older versions of Trac #OlderVersions
    218239
    219240For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].