Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
09/27/05 22:35:03 (21 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v2 v3  
    66 '''Note''': ''Environment upgrades are not necessary for minor version releases unless otherwise noted. For example, there's no need to upgrade a Trac environment created with (or upgraded) 0.8.0 when installing 0.8.4 (or any other 0.8.x release).''
    77
    8 == Upgrade Synopsis ==
     8== General Instructions ==
    99
    10 A typical upgrade looks like the following:
     10Typically, there are four steps involved in upgrading to a newer version of Trac:
    1111
    12  1. You upgrade the Trac source code - from an offical release or from a source checkout.
    13  2. You run the `trac-admin upgrade` command to bring the database up-to-date with the new Trac code. The table structure changes over time, but it is versioned. The upgrade command find the current version of the DB and the version required by the code, and performs an upgrade if required.
    14  3. Optionally, you can run the `wiki upgrade` command to bring the default Wiki pages up-to-date. Your `WikiStart` page will be left intact, of course.
     12=== Update the Trac Code ===
     13
     14Get the new version of Trac, either by downloading an offical release package or by checking it out from the [http://projects.edgewall.com/trac/wiki/SubversionRepository Subversion repository].
     15
     16If you have a source distribution, you need to run
     17{{{
     18python setup.py install
     19}}}
     20
     21to install the new version. If you've downloaded the Windows installer, you execute it, and so on.
     22
     23In any case, if you're doing a major version upgrade (such as from 0.8 to 0.9), it is ''highly'' recommended that you first remove the existing Trac code. To do this, you need to delete the `trac` directory from the Python `lib/site-packages` directory. You may also want to remove the Trac `cgi-bin`, `htdocs` and `templates` directories that are commonly found in a directory called `share/trac` (the exact location depends on your platform).
     24
     25=== Upgrade the Trac Environment ===
     26
     27Unless noted otherwise, upgrading between major versions (such as 0.8 and 0.9) involves changes to the database schema, and possibly the layout of the [wiki:TracEnvironment environment directory]. Fortunately, Trac provides automated upgrade scripts to ease the pain. These scripts are run via [wiki:TracAdmin trac-admin]:
     28{{{
     29trac-admin /path/to/projenv upgrade
     30}}}
     31
     32This command will do nothing if the environment is already up-to-date. [[BR]]
     33
     34=== Update the Trac Documentation ===
     35
     36Every [wiki: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, [wiki:TracAdmin trac-admin] provides a command to upgrade the documentation:
     37{{{
     38trac-admin /path/to/projenv wiki upgrade
     39}}}
     40
     41Note that this procedure will of course leave your `WikiStart` page intact.
     42
     43=== Restart the Web Server ===
     44
     45In order to reload the new Trac code you will need to restart your web server (note this is not necessary for plain old CGI, although CGI is discouraged for performance reasons).
     46
     47== Specific Versions ==
     48
     49The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac.
    1550
    1651== From 0.8.x to 0.9 ==
    1752
    18 The database schema was changed between 0.8.x and 0.9. Existing environments must be upgraded before they can be used with Trac 0.9.
     53If you're using [wiki:TracCgi CGI] you will want to update your `Alias` to the Trac htdocs static resources.  See the documentation on [wiki:TracCgi#MappingStaticResources mapping static resources] for an example on how to configure this.
    1954
    20 The following command will automatically perform the upgrade:
    21 {{{
    22  $ trac-admin /path/to/projectenv upgrade
    23 }}}
     55[wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python] users can safely remove any `Alias`es to the Trac htdocs folder since this is no longer used by default.
    2456
    25 Trac environments are created with a default set of wiki pages. It's recommended to update these pages on existing environments whenever Trac is upgraded to get up-to-date documentation and additional functionality. The following command will perform the update:
    26 {{{
    27  $ trac-admin /path/to/projectenv wiki upgrade
    28 }}}
    29 
    30 If you're using [wiki:TracModPython mod_python], you will need to change the name of the mod_python handler in the Apache HTTPD configuration:
     57[wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration:
    3158{{{
    3259   from: PythonHandler trac.ModPythonHandler
    … …  
    3461}}}
    3562
    36 == From 0.7.x to 0.8 ==
     63If you have [http://initd.org/tracker/pysqlite PySQLite] 2.x installed, Trac will now try to open your SQLite database using the SQLite 3.x file format. The database formats used by SQLite 2.8.x and SQLite 3.x are incompatible. If you get an error like ''“file is encrypted or is not a database”'' after upgrading, then you must convert your database file.
    3764
    38 The database schema was changed between 0.7.x and 0.8. Existing environments
    39 must be upgraded before they can be used with Trac 0.8.
    40 
    41 The following command will automatically perform the upgrade:
     65To do this, you need to have both SQLite 2.8.x and SQLite 3.x installed (they have different filenames so can coexist on the same system). Then use the following commands:
    4266{{{
    43  $ trac-admin /path/to/projectenv upgrade
     67 $ mv trac.db trac2.db
     68 $ sqlite trac2.db .dump | sqlite3 trac.db
    4469}}}
    4570
    46 Trac environments are created with a default set of wiki pages. It's
    47 recommended to update these pages on existing environments whenever
    48 Trac is upgraded to get up-to-date documentation and additional functionality.
    49 The following command will perform the update:
    50 {{{
    51  $ trac-admin /path/to/projectenv wiki upgrade
    52 }}}
     71After testing that the conversion was successful, the `trac2.db` file can be deleted. For more information on the SQLite upgrade see http://www.sqlite.org/version3.html.
     72
     73== From 0.7.x to 0.8 ==
    5374
    54750.8 adds a new roadmap feature which requires additional permissions. While a
    … …  
    6182}}}
    6283
    63 == Upgrading SQLite from 2.x to 3.x ==
    64 
    65 The database formats used by SQLite 2.x and sqlite 3.x are incompatible. If you upgrade your SQLite version (this can  also happen implicitly if you upgrade from PySQLite 1.0.x to 1.1.x or 2.x), then you must convert your database.
    66 
    67 To do this, install both SQLite 2.8 and SQLite 3.x  (they have different filenames so can coexist in the same directory). Then use the following commands (Windows):
    68 {{{
    69  $ mv trac.db trac2.db
    70  $ sqlite trac2.db .dump | sqlite3 trac.db
    71 }}}
    72 
    73 Then when you're happy with the conversion and tested everything  you can delete the trac2.db file.
    74 
    75 For more information see http://www.sqlite.org/version3.html
    76 
    7784-----
    7885See also: TracGuide, TracInstall