Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
22 Apr 2015 15:34:51 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    1 = Upgrade Instructions =
     1= Upgrade Instructions
    22[[TracGuideToc]]
    3 
    4 == Instructions ==
    5 
    6 Typically, there are five steps involved in upgrading to a newer version of Trac:
    7 
    8 === 1. Update the Trac Code === #UpdatetheTracCode
     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
    916
    1017Get the new version as described in TracInstall, or your operating system specific procedure.
    1118
    12 If you installed a recent 0.11 version of Trac via {{{easy_install}}}, it might be the easiest to use it also to upgrade you Trac installation.
    13 
    14 {{{
    15 # easy_install --upgrade Trac
    16 }}}
    17 
    18 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]).
    19 
    20 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.
    21 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:
    22  * on Linux: /usr/lib/python2.X/site-packages
    23  * on Windows: C:\Python2.X\lib\site-packages
    24  * on MacOSX: /Library/Python/2.X/site-packages
    25 
    26 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).
    27 
    28 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.
    29 
    30 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
    31 
    32 === 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     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
    3336
    3437Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3538
    3639After 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]:
    37 {{{
     40{{{#!sh
    3841trac-admin /path/to/projenv upgrade
    3942}}}
     
    4245
    4346Note that a backup of your database will be performed automatically prior to the upgrade.
    44 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:
    45 {{{
     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
    4649trac-admin /path/to/projenv upgrade --no-backup
    4750}}}
    4851
    49 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.
    50 
    51 === 3. Update the Trac Documentation === #UpdatetheTracDocumentation
    52 
    53 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:
    54 {{{
     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
    5556trac-admin /path/to/projenv wiki upgrade
    5657}}}
    5758
    58 Note that this procedure will of course leave your `WikiStart` page intact.
    59 
    60 === 4. Resynchronize the Trac Environment Against the Source Code Repository ===
    61 
    62 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:
    63 
    64 {{{
    65 trac-admin /path/to/projenv resync
    66 }}}
    67 
    68 === 5. Steps specific to a given Trac version  ===
    69 ==== Upgrading to Trac 0.11 ====
    70 ===== Site Templates =====
    71 The templating engine has changed in 0.11, please look at TracInterfaceCustomization for more information.
    72 
    73 ===== Trac Macros, Plugins =====
    74 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.
    75 
    76 ===== For FCGI/WSGI/CGI users =====
     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===== Subversion components not enabled by default for new installations
     82The 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:
     83{{{#!ini
     84[components]
     85tracopt.versioncontrol.svn.* = enabled
     86}}}
     87The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
     88
     89===== Attachments migrated to new location
     90Another 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.
     91
     92===== Behavior of `[ticket] default_owner` changed
     93Prior 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.
     94
     95==== Upgrading from Trac 0.11 to Trac 0.12
     96
     97===== Python 2.3 no longer supported
     98The minimum supported version of Python is now 2.4.
     99
     100===== SQLite v3.x required
     101SQLite 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.
     102
     103===== [trac:PySqlite] 2 required
     104[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
     105
     106===== Multiple Repository Support
     107The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
     108
     109This 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.
     110
     111===== Resynchronize the Trac Environment Against the Source Code Repository
     112
     113Each [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:
     114
     115{{{#!sh
     116trac-admin /path/to/projenv repository resync '*'
     117}}}
     118
     119===== Improved repository synchronization
     120In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
     121
     122While 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.
     123
     124Note 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.
     125
     126===== Authz permission checking
     127The 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.
     128
     129===== Microsecond timestamps
     130All 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.
     131
     132==== Upgrading from Trac 0.10 to Trac 0.11
     133===== Site Templates and Styles
     134The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
     135
     136If 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.
     137
     138===== Trac Macros, Plugins
     139The 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.
     140
     141===== For FCGI/WSGI/CGI users
    77142For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    78 {{{
     143{{{#!sh
    79144trac-admin /path/to/env deploy /deploy/directory/path
    80145}}}
     
    82147This 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.
    83148
    84 === 6. Restart the Web Server === #RestarttheWebServer
     149===== Web Admin plugin integrated
     150If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     151
     152===== New Default Configurable Workflow
     153
     154When 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.
     155
     156Graphically, that looks like this:
     157
     158{{{#!Workflow width=500 height=240
     159leave = * -> *
     160leave.operations = leave_status
     161leave.default = 1
     162accept = new -> assigned
     163accept.permissions = TICKET_MODIFY
     164accept.operations = set_owner_to_self
     165resolve = new,assigned,reopened -> closed
     166resolve.permissions = TICKET_MODIFY
     167resolve.operations = set_resolution
     168reassign = new,assigned,reopened -> new
     169reassign.permissions = TICKET_MODIFY
     170reassign.operations = set_owner
     171reopen = closed -> reopened
     172reopen.permissions = TICKET_CREATE
     173reopen.operations = del_resolution
     174}}}
     175
     176There 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.
     177
     178===== Global Configuration
     179In 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.
     180
     181=== 7. Restart the Web Server #RestarttheWebServer
    85182
    86183If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    87184
    88 == Known Issues ==
    89 
    90 === parent dir ===
    91 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
    92 
    93 === some core modules won't load ===
    94 This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
    95 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:
    96 {{{
    97 ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
    98 }}}
    99 Remove the `Lib/site-packages/trac` folder and reinstall.
    100 
    101 === Wiki Upgrade ===
     185== Known Issues
     186
     187=== Customized Templates
     188
     189Trac 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.
     190
     191The 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.
     192
     193=== !ZipImportError
     194
     195Due 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.
     196See [trac:#7014] for details.
     197
     198=== Wiki Upgrade
    102199`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.
    103200
    104 
    105 == Changing Database Backend ==
    106 === SQLite to PostgreSQL ===
    107 
    108 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
    109 
    110 == Older Versions ==
    111 
    112 For upgrades from versions older than Trac 0.10, refer first to trac:wiki:0.10/TracUpgrade.
    113 
    114 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.
    115 {{{
    116 $ sqlite3 db/trac.db "update system set value=20 where name='database_version'"
    117 }}}
    118 (upgrade can be redone the normal way later on)
     201=== Trac database upgrade
     202
     203A 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].
     204
     205=== Parent dir
     206If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
     207
     208== Related topics
     209
     210=== Upgrading Python
     211
     212Upgrading 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.
     213
     214==== Windows and Python 2.6
     215
     216If 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.
     217
     218=== Changing Database Backend
     219
     220The [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.
     221
     222=== Upgrading from older versions of Trac #OlderVersions
     223
     224For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
    119225
    120226-----