Edgewall Software

Changes between Version 111 and Version 112 of TracUpgrade


Ignore:
Timestamp:
Feb 9, 2015, 5:42:58 AM (7 years ago)
Author:
Ryan J Ollos
Comment:

New-style markup and syntax highlighting.

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v111 v112  
    1 = Upgrade Instructions =
     1= Upgrade Instructions
    22[[TracGuideToc]]
    33[[TranslatedPages]]
    44[[PageOutline(2-4,,inline,unnumbered)]]
    55
    6 == Instructions ==
     6== Instructions
    77
    88Typically, there are seven steps involved in upgrading to a newer version of Trac:
     
    1212It 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].
    1313
    14 === 2. Update the Trac Code === #UpdatetheTracCode
     14=== 2. Update the Trac Code #UpdatetheTracCode
    1515
    1616Get the new version as described in TracInstall, or your operating system specific procedure.
     
    1818If 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:
    1919
    20 {{{
    21 # easy_install --upgrade Trac==1.0
     20{{{#!sh
     21easy_install --upgrade Trac==1.0
    2222}}}
    2323
     
    3232You 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.
    3333
    34 === 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     34=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    3535
    3636Environment upgrades are not necessary for minor version releases unless otherwise noted.
    3737
    3838After 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]:
    39 {{{
     39{{{#!sh
    4040trac-admin /path/to/projenv upgrade
    4141}}}
     
    4545Note that a backup of your database will be performed automatically prior to the upgrade.
    4646This 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:
    47 {{{
     47{{{#!sh
    4848trac-admin /path/to/projenv upgrade --no-backup
    4949}}}
     
    5252
    5353By 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:
    54 {{{
     54{{{#!sh
    5555trac-admin /path/to/projenv wiki upgrade
    5656}}}
     
    5858Note that this procedure will leave your `WikiStart` page intact.
    5959
    60 === 5. Refresh static resources ===
     60=== 5. Refresh static resources
    6161
    6262If 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:
    63 {{{
     63{{{#!sh
    6464trac-admin /path/to/env deploy /deploy/path
    6565}}}
     
    7171}}}
    7272
    73 === 6. Steps specific to a given Trac version  ===
    74 
    75 ==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0
    76 
    77 ===== Python 2.4 no longer supported =====
     73=== 6. Steps specific to a given Trac version
     74
     75==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
     76
     77===== Python 2.4 no longer supported
    7878Upgrade Python to at least 2.5, but not 3.0.
    7979
    8080===== Subversion components not enabled by default for new installations
    8181The 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:
    82 {{{
     82{{{#!ini
    8383[components]
    8484tracopt.versioncontrol.svn.* = enabled
     
    9292Prior 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.
    9393
    94 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
    95 
    96 ===== Python 2.3 no longer supported =====
     94==== Upgrading from Trac 0.11 to Trac 0.12
     95
     96===== Python 2.3 no longer supported
    9797The minimum supported version of Python is now 2.4.
    9898
    99 ===== SQLite v3.x required =====
     99===== SQLite v3.x required
    100100SQLite 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.
    101101
    102 ===== [trac:PySqlite] 2 required =====
     102===== [trac:PySqlite] 2 required
    103103[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    104104
    105 ===== Multiple Repository Support =====
     105===== Multiple Repository Support
    106106The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    107107
    108108This 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.
    109109
    110 ===== Resynchronize the Trac Environment Against the Source Code Repository =====
     110===== Resynchronize the Trac Environment Against the Source Code Repository
    111111
    112112Each [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:
    113113
    114 {{{
     114{{{#!sh
    115115trac-admin /path/to/projenv repository resync '*'
    116116}}}
    117117
    118 ===== Improved repository synchronization =====
     118===== Improved repository synchronization
    119119In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    120120
     
    123123Note 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.
    124124
    125 ===== Authz permission checking =====
     125===== Authz permission checking
    126126The 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.
    127127
    128 ===== Microsecond timestamps =====
     128===== Microsecond timestamps
    129129All 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.
    130130
    131 ==== Upgrading from Trac 0.10 to Trac 0.11 ====
    132 ===== Site Templates and Styles =====
     131==== Upgrading from Trac 0.10 to Trac 0.11
     132===== Site Templates and Styles
    133133The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    134134
    135135If 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.
    136136
    137 ===== Trac Macros, Plugins =====
     137===== Trac Macros, Plugins
    138138The 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.
    139139
    140 ===== For FCGI/WSGI/CGI users =====
     140===== For FCGI/WSGI/CGI users
    141141For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    142 {{{
     142{{{#!sh
    143143trac-admin /path/to/env deploy /deploy/directory/path
    144144}}}
     
    146146This 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.
    147147
    148 ===== Web Admin plugin integrated =====
     148===== Web Admin plugin integrated
    149149If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    150150
     
    175175There 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.
    176176
    177 === 7. Restart the Web Server === #RestarttheWebServer
     177=== 7. Restart the Web Server #RestarttheWebServer
    178178
    179179If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
    180180
    181 == Known Issues ==
     181== Known Issues
    182182
    183183=== Customized Templates
     
    187187The 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.
    188188
    189 === !ZipImportError ===
     189=== !ZipImportError
    190190
    191191Due 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.
    192192See [trac:#7014] for details.
    193193
    194 === Wiki Upgrade ===
     194=== Wiki Upgrade
    195195`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.
    196196
    197 === Trac database upgrade ===
     197=== Trac database upgrade
    198198
    199199A 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].
    200200
    201 === Parent dir ===
     201=== Parent dir
    202202If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    203203
    204204== Related topics
    205205
    206 === Upgrading Python ===
     206=== Upgrading Python
    207207
    208208Upgrading 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.
    209209
    210 ==== Windows and Python 2.6 ====
     210==== Windows and Python 2.6
    211211
    212212If 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.
    213213
    214 === Changing Database Backend ===
     214=== Changing Database Backend
    215215
    216216The [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.
    217217
    218 === Upgrading from older versions of Trac === #OlderVersions
     218=== Upgrading from older versions of Trac #OlderVersions
    219219
    220220For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].