Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
May 5, 2015, 2:14:49 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    11= Upgrade Instructions =
    22[[TracGuideToc]]
     3[[PageOutline(2-4,,inline,unnumbered)]]
    34
    45== Instructions ==
    56
    6 Typically, there are five steps involved in upgrading to a newer version of Trac:
    7 
    8 === 1. Update the Trac Code === #UpdatetheTracCode
     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
     13=== 2. Update the Trac Code === #UpdatetheTracCode
    914
    1015Get the new version as described in TracInstall, or your operating system specific procedure.
    1116
    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
     17If 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:
     18
     19{{{
     20# easy_install --upgrade Trac==1.0
     21}}}
     22
     23If 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]).
     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:
     27 * on Linux: `/usr/lib/python2.X/site-packages`
     28 * on Windows: `C:\Python2.X\lib\site-packages`
     29 * on MacOSX: `/Library/Python/2.X/site-packages`
     30
     31You 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.
     32
     33=== 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
    3334
    3435Environment upgrades are not necessary for minor version releases unless otherwise noted.
     
    4243
    4344Note 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:
     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, run:
    4546{{{
    4647trac-admin /path/to/projenv upgrade --no-backup
    4748}}}
    4849
    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:
     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:
    5453{{{
    5554trac-admin /path/to/projenv wiki upgrade
    5655}}}
    5756
    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.
     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{{{
     63trac-admin /path/to/env deploy /deploy/path
     64}}}
     65this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
     66
     67Some 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.
     68{{{#!comment
     69Remove above note once #9936 is fixed.
     70}}}
     71
     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 =====
     77Upgrade Python to at least 2.5, but not 3.0.
     78
     79===== Subversion components not enabled by default for new installations
     80The 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{{{
     82[components]
     83tracopt.versioncontrol.svn.* = enabled
     84}}}
     85The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
     86
     87===== Attachments migrated to new location
     88Another 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.
     89
     90===== Behavior of `[ticket] default_owner` changed
     91Prior 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.
     92
     93==== Upgrading from Trac 0.11 to Trac 0.12 ====
     94
     95===== Python 2.3 no longer supported =====
     96The minimum supported version of Python is now 2.4.
     97
     98===== SQLite v3.x required =====
     99SQLite 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.
     100
     101===== [trac:PySqlite] 2 required =====
     102[trac: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 =====
     105The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
     106
     107This 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.
     108
     109===== Resynchronize the Trac Environment Against the Source Code Repository =====
     110
     111Each [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:
     112
     113{{{
     114trac-admin /path/to/projenv repository resync '*'
     115}}}
     116
     117===== Improved repository synchronization =====
     118In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
     119
     120While 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.
     121
     122Note 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.
     123
     124===== Authz permission checking =====
     125The 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.
     126
     127===== Microsecond timestamps =====
     128All 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.
     129
     130==== Upgrading from Trac 0.10 to Trac 0.11 ====
     131===== Site Templates and Styles =====
     132The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
     133
     134If 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.
    72135
    73136===== 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.
     137The 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.
    75138
    76139===== For FCGI/WSGI/CGI users =====
     
    82145This 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.
    83146
    84 === 6. Restart the Web Server === #RestarttheWebServer
     147===== Web Admin plugin integrated =====
     148If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
     149
     150===== New Default Configurable Workflow
     151
     152When 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.
     153
     154Graphically, that looks like this:
     155
     156{{{#!Workflow width=500 height=240
     157leave = * -> *
     158leave.operations = leave_status
     159leave.default = 1
     160accept = new -> assigned
     161accept.permissions = TICKET_MODIFY
     162accept.operations = set_owner_to_self
     163resolve = new,assigned,reopened -> closed
     164resolve.permissions = TICKET_MODIFY
     165resolve.operations = set_resolution
     166reassign = new,assigned,reopened -> new
     167reassign.permissions = TICKET_MODIFY
     168reassign.operations = set_owner
     169reopen = closed -> reopened
     170reopen.permissions = TICKET_CREATE
     171reopen.operations = del_resolution
     172}}}
     173
     174There 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.
     175
     176=== 7. Restart the Web Server === #RestarttheWebServer
    85177
    86178If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
     
    88180== Known Issues ==
    89181
    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.
     182=== Customized Templates
     183
     184Trac 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.
     185
     186The 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.
     187
     188=== !ZipImportError ===
     189
     190Due 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.
     191See [trac:#7014] for details.
    100192
    101193=== Wiki Upgrade ===
    102194`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.
    103195
    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)
     196=== Trac database upgrade ===
     197
     198A 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].
     199
     200=== Parent dir ===
     201If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
     202
     203== Related topics
     204
     205=== Upgrading Python ===
     206
     207Upgrading 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.
     208
     209==== Windows and Python 2.6 ====
     210
     211If 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.
     212
     213=== Changing Database Backend ===
     214
     215The [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.
     216
     217=== Upgrading from older versions of Trac === #OlderVersions
     218
     219For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
    119220
    120221-----