Context Navigation

Changes between Version 1 and Version 2 of TracUpgrade

Timestamp:: Apr 28, 2008, 2:20:37 PM (17 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracUpgrade

-                      v1
+                      v2
 [[TracGuideToc]]
 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.
+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.
+ '''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).''
+Environment upgrades are not necessary for minor version releases unless otherwise noted.
+== General Instructions ==
+== Instructions ==
 Typically, there are four steps involved in upgrading to a newer version of Trac:
 …
 === Update the Trac Code ===
 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].
+Get the new version as described in TracInstall, or your operation system specific procedure.
+If you have a source distribution, you need to run
+{{{
+python setup.py install
+}}}
+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.
+to install the new version. If you've downloaded the Windows installer, you execute it, and so on.
+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:
+ * If you’re using Linux: /usr/lib/python2.X/site-packages
+ * If you’re using Windows: C:\Python2.X\lib\site-packages
+ * If you’re using MacOSX: /Library/Python2.X/site-packages
+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).
+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).
+> If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.
 === Upgrade the Trac Environment ===
 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]:
+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]:
 {{{
 trac-admin /path/to/projenv upgrade
 …
 === Update the Trac Documentation ===
 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:
+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:
 {{{
 trac-admin /path/to/projenv wiki upgrade
 …
 Note that this procedure will of course leave your `WikiStart` page intact.
+=== Trac Macros, Plugins ===
+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 TracWikiMacros.
 === Restart the Web Server ===
+If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
+In order to reload the new Trac code you will need to restart your web server (note this is not necessary for [wiki:TracCgi CGI]).
+== Known Issues ==
+=== parent dir ===
+If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
+== Specific Versions ==
+== Changing Database Backend ==
+== SQLite to PostgreSQL ==
 The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac.
+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
 == From 0.9-beta to 0.9 ==
+== Older Versions ==
+If inclusion of the static resources (style sheets, javascript, images) is not working, check the value of the `htdocs_location` in trac.ini. For [wiki:TracModPython mod_python], [wiki:TracStandalone Tracd] and [wiki:TracFastCgi FastCGI], you can simply remove the option altogether. For [wiki:TracCgi CGI], you should fix it to point to the URL you mapped the Trac `htdocs` directory to (although you can also remove it and then [wiki:TracCgi#MappingStaticResources map the static resources]). If you're still having problems after removing the option, check the paths in the `trac/siteconfig.py` file and fix them if they're incorrect.
+If you've been using plugins with a beta release of Trac 0.9, or have disabled some of the built-in components, you might have to update the rules for disabling/enabling components in [wiki:TracIni trac.ini]. In particular, globally installed plugins now need to be enabled explicitly. See TracPlugins and TracIni for more information.
+If you want to enable the display of all ticket changes in the timeline (the “Ticket Details” option), you now have to explicitly enable that in [wiki:TracIni trac.ini], too:
+{{{
+[timeline]
+ticket_show_details = true
+}}}
+== From 0.8.x to 0.9 ==
+[wiki:TracModPython mod_python] users will also need to change the name of the mod_python handler in the Apache HTTPD configuration:
+{{{
+   from: PythonHandler trac.ModPythonHandler
+   to:   PythonHandler trac.web.modpython_frontend
+}}}
+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.
+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:
+{{{
+ $ mv trac.db trac2.db
+ $ sqlite trac2.db .dump | sqlite3 trac.db
+}}}
+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.
+== From 0.7.x to 0.8 ==
+.8 adds a new roadmap feature which requires additional permissions. While a
+fresh installation will by default grant ROADMAP_VIEW and MILESTONE_VIEW
+permissions to anonymous, these permissions have to be granted manually when
+upgrading:
+{{{
+ $ trac-admin /path/to/projectenv permission add anonymous MILESTONE_VIEW
+ $ trac-admin /path/to/projectenv permission add anonymous ROADMAP_VIEW
+}}}
+For upgrades from former versions refer to wiki:0.10/TracUpgrade.
 -----