Changes between Version 2 and Version 3 of TracUpgrade
- Timestamp:
- Jan 25, 2009 10:55:11 AM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracUpgrade
v2 v3 2 2 [[TracGuideToc]] 3 3 4 A Trac environment sometimes needs to be upgraded before it can be used with a new version of Trac. This document describes the steps necessary to upgrade an environment.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. 5 5 6 '''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).'' 6 Environment upgrades are not necessary for minor version releases unless otherwise noted. 7 7 8 == GeneralInstructions ==8 == Instructions == 9 9 10 10 Typically, there are four steps involved in upgrading to a newer version of Trac: … … 12 12 === Update the Trac Code === 13 13 14 Get 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].14 Get the new version as described in TracInstall, or your operating system specific procedure. 15 15 16 If you have a source distribution, you need to run 17 {{{ 18 python setup.py install 19 }}} 16 If you do a manual (not operating system specific) upgrade, you may also later on want to remove the existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory. 20 17 21 to install the new version. If you've downloaded the Windows installer, you execute it, and so on. 18 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: 19 * If you’re using Linux: /usr/lib/python2.X/site-packages 20 * If you’re using Windows: C:\Python2.X\lib\site-packages 21 * If you’re using MacOSX: /Library/Python2.X/site-packages 22 22 23 In 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). 23 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). 24 25 If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base. 24 26 25 27 === Upgrade the Trac Environment === 26 28 27 Unless 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]:29 After 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]: 28 30 {{{ 29 31 trac-admin /path/to/projenv upgrade 30 32 }}} 31 33 32 This command will do nothing if the environment is already up-to-date. [[BR]] 34 This command will do nothing if the environment is already up-to-date. 35 36 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: 37 {{{ 38 trac-admin /path/to/projenv upgrade --no-backup 39 }}} 40 41 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. 33 42 34 43 === Update the Trac Documentation === 35 44 36 Every [ 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:45 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: 37 46 {{{ 38 47 trac-admin /path/to/projenv wiki upgrade … … 41 50 Note that this procedure will of course leave your `WikiStart` page intact. 42 51 52 === Trac Macros, Plugins === 53 The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of 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. 54 43 55 === Restart the Web Server === 56 If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. 44 57 45 In 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). 58 == Known Issues == 59 === parent dir === 60 If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work. 61 === some core modules won't load === 62 This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first. 63 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: 64 {{{ 65 ERROR: Skipping "trac.about = trac.about": (can't import "No module named about") 66 }}} 67 Remove the `Lib/site-packages/trac` folder and reinstall. 68 === Wiki Upgrade === 69 `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. 46 70 47 == Specific Versions == 71 == Changing Database Backend == 72 == SQLite to PostgreSQL == 48 73 49 The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac.74 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 50 75 51 == From 0.8.x to 0.9==76 == Older Versions == 52 77 53 If 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. 54 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. 56 57 [wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration: 58 {{{ 59 from: PythonHandler trac.ModPythonHandler 60 to: PythonHandler trac.web.modpython_frontend 61 }}} 62 63 If 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. 64 65 To 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: 66 {{{ 67 $ mv trac.db trac2.db 68 $ sqlite trac2.db .dump | sqlite3 trac.db 69 }}} 70 71 After 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 == 74 75 0.8 adds a new roadmap feature which requires additional permissions. While a 76 fresh installation will by default grant ROADMAP_VIEW and MILESTONE_VIEW 77 permissions to anonymous, these permissions have to be granted manually when 78 upgrading: 79 {{{ 80 $ trac-admin /path/to/projectenv permission add anonymous MILESTONE_VIEW 81 $ trac-admin /path/to/projectenv permission add anonymous ROADMAP_VIEW 82 }}} 78 For upgrades from former versions refer to wiki:0.10/TracUpgrade. 83 79 84 80 -----