Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
06/24/16 22:52:01 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v2 v3  
    1 = Upgrade Instructions =
     1= Upgrade Instructions
    22[[TracGuideToc]]
    3 
    4 A [TracEnvironment Trac environment] needs to be upgraded before it can be used with Trac 0.11. This document describes the steps necessary to upgrade an environment.
     3[[PageOutline(2-4,,inline,unnumbered)]]
     4
     5== Instructions
     6
     7Typically, there are seven steps involved in upgrading to a newer version of Trac:
     8
     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 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]).
     26
     27You 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.
     28The 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:
     29 * on Linux: `/usr/lib/python2.X/site-packages`
     30 * on Windows: `C:\Python2.X\lib\site-packages`
     31 * on MacOSX: `/Library/Python/2.X/site-packages`
     32
     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.
     34
     35=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    536
    637Environment upgrades are not necessary for minor version releases unless otherwise noted.
    738
    8 == Instructions ==
    9 
    10 Typically, there are four steps involved in upgrading to a newer version of Trac:
    11 
    12 === Update the Trac Code ===
    13 
    14 Get the new version as described in TracInstall, or your operating system specific procedure.
    15 
    16 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]).
    17 
    18 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.
    19 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:
    20  * If you’re using Linux: /usr/lib/python2.X/site-packages
    21  * If you’re using Windows: C:\Python2.X\lib\site-packages
    22  * If you’re using MacOSX: /Library/Python/2.X/site-packages
    23 
    24 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).
    25 
    26 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.
    27 
    28 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    29 
    30 === Upgrade the Trac Environment ===
    31 
    3239After 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]:
    33 {{{
     40{{{#!sh
    3441trac-admin /path/to/projenv upgrade
    3542}}}
    … …  
    3744This command will do nothing if the environment is already up-to-date.
    3845
    39 Note that if you are using a PostgreSQL database, this command will fail with the message that the environment can only be backed up when you use an SQLite database. This means that you will have to backup the repository and the database manually. Then, to perform the actual upgrade, run:
    40 {{{
     46Note that a backup of your database will be performed automatically prior to the 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:
     48{{{#!sh
    4149trac-admin /path/to/projenv upgrade --no-backup
    4250}}}
    4351
    44 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.
    45 
    46 === Update the Trac Documentation ===
    47 
    48 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:
    49 {{{
     52=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
     53
     54By 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:
     55{{{#!sh
    5056trac-admin /path/to/projenv wiki upgrade
    5157}}}
    5258
    53 Note that this procedure will of course leave your `WikiStart` page intact.
    54 
    55 === Site Templates ===
    56 The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information.
    57 
    58 === Trac Macros, Plugins ===
    59 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.
    60 
    61 === For CGI users ===
    62 
    63 For those who run Trac under the CGI environment, run this command in order to obtain the trac.cgi file:
    64 {{{
     59Note that this procedure will leave your `WikiStart` page intact.
     60
     61=== 5. Refresh static resources
     62
     63If 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:
     64{{{#!sh
     65trac-admin /path/to/env deploy /deploy/path
     66}}}
     67this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
     68
     69Some 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.
     70{{{#!comment
     71Remove above note once #9936 is fixed.
     72}}}
     73
     74=== 6. Steps specific to a given Trac version
     75
     76==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     77
     78===== Python 2.4 no longer supported
     79Upgrade Python to at least 2.5, but not 3.0.
     80
     81===== Obsolete Plugins
     82
     83Trac has added functionality equivalent to the following plugins:
     84
     85* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
     86* ​[https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     87* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
     88
     89The plugins should be removed when upgrading Trac to 1.0.
     90
     91===== Subversion components not enabled by default for new installations
     92The 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:
     93{{{#!ini
     94[components]
     95tracopt.versioncontrol.svn.* = enabled
     96}}}
     97The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
     98
     99===== Attachments migrated to new location
     100Another 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.
     101
     102===== Behavior of `[ticket] default_owner` changed
     103Prior 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.
     104
     105==== Upgrading from Trac 0.11 to Trac 0.12
     106
     107===== Python 2.3 no longer supported
     108The minimum supported version of Python is now 2.4.
     109
     110===== SQLite v3.x required
     111SQLite 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.
     112
     113===== [trac:PySqlite] 2 required
     114[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
     115
     116===== Obsolete Plugins
     117
     118Trac has added functionality equivalent to the following plugins:
     119
     120* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
     121* ​[https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     122* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
     123* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
     124* [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter`
     125* [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories
     126* [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole]
     127* [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1)
     128
     129The plugins should be removed when upgrading Trac to 0.12.
     130
     131===== Multiple Repository Support
     132The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
     133
     134This 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.
     135
     136===== Resynchronize the Trac Environment Against the Source Code Repository
     137
     138Each [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:
     139
     140{{{#!sh
     141trac-admin /path/to/projenv repository resync '*'
     142}}}
     143
     144===== Improved repository synchronization
     145In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
     146
     147While 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.
     148
     149Note 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.
     150
     151===== Authz permission checking
     152The 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.
     153
     154===== Microsecond timestamps
     155All 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.
     156
     157==== Upgrading from Trac 0.10 to Trac 0.11
     158===== Site Templates and Styles
     159The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
     160
     161If 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.
     162
     163===== Trac Macros, Plugins
     164The 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.
     165
     166===== For FCGI/WSGI/CGI users
     167For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
     168{{{#!sh
    65169trac-admin /path/to/env deploy /deploy/directory/path
    66170}}}
    … …  
    68172This 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.
    69173
    70 === Restart the Web Server ===
     174===== Web Admin plugin integrated
     175If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     176
     177===== New Default Configurable Workflow
     178
     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:
     182
     183{{{#!Workflow width=500 height=240
     184leave = * -> *
     185leave.operations = leave_status
     186leave.default = 1
     187accept = new -> assigned
     188accept.permissions = TICKET_MODIFY
     189accept.operations = set_owner_to_self
     190resolve = new,assigned,reopened -> closed
     191resolve.permissions = TICKET_MODIFY
     192resolve.operations = set_resolution
     193reassign = new,assigned,reopened -> new
     194reassign.permissions = TICKET_MODIFY
     195reassign.operations = set_owner
     196reopen = closed -> reopened
     197reopen.permissions = TICKET_CREATE
     198reopen.operations = del_resolution
     199}}}
     200
     201There 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.
     202
     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
     206=== 7. Restart the Web Server #RestarttheWebServer
     207
    71208If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    72209
    73 == Known Issues ==
    74 === parent dir ===
    75 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
    76 === some core modules won't load ===
    77 This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
    78 Some modules were previously capitalized and were changed to lower case, e.g. trac/About.py became trac/about.py. You may find such messages in the Trac log:
    79 {{{
    80 ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
    81 }}}
    82 Remove the `Lib/site-packages/trac` folder and reinstall.
    83 === Wiki Upgrade ===
    84 `trac-admin` will not delete or remove pages that were in version 0.10 but now are not in version 0.11, such as WikiMacros.
    85 
    86 == Changing Database Backend ==
    87 == SQLite to PostgreSQL ==
    88 
    89 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
    90 
    91 == Older Versions ==
    92 
    93 For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade.
    94 
    95 Note that downgrading from Trac 0.11 to Trac 0.10.4 or 0.10.5 is easy, but has to be done manually, e.g.
    96 {{{
    97 $ sqlite3 db/trac.db "update system set value=20 where name='database_version'"
    98 }}}
    99 (upgrade can be redone the normal way later on)
     210== Known Issues
     211
     212=== Customized Templates
     213
     214Trac 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.
     215
     216The 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.
     217
     218=== !ZipImportError
     219
     220Due 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.
     221See [trac:#7014] for details.
     222
     223=== Wiki Upgrade
     224`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.
     225
     226=== Trac database upgrade
     227
     228A 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].
     229
     230=== Parent dir
     231If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
     232
     233== Related topics
     234
     235=== Upgrading Python
     236
     237Upgrading 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.
     238
     239==== Windows and Python 2.6
     240
     241If 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.
     242
     243=== Changing Database Backend
     244
     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.
     246
     247=== Upgrading from older versions of Trac #OlderVersions
     248
     249For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
    100250
    101251-----