Changes between Version 2 and Version 3 of TracUpgrade


Ignore:
Timestamp:
08/06/12 19:25:53 (12 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracUpgrade

    v2 v3  
    1010Get the new version as described in TracInstall, or your operating system specific procedure.
    1111
    12 If you already have a 0.11 version of Trac installed via `easy_install`, it might be the easiest to use it also to upgrade you Trac installation.
     12If you already have a 0.11 version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:
    1313
    1414{{{
    15 # easy_install --upgrade Trac==0.12b1
     15# easy_install --upgrade Trac==0.12
    1616}}}
    17 (once beta1 is released, that is)
    1817
    19 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]).
     18If 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]).
    2019
    21 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.
    22 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:
     20You 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.
     21The 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:
    2322 * on Linux: `/usr/lib/python2.X/site-packages`
    2423 * on Windows: `C:\Python2.X\lib\site-packages`
    2524 * on MacOSX: `/Library/Python/2.X/site-packages`
    2625
    27 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).
     26You 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.)
    2827
    29 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.
     28This cleanup is not mandatory, but 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.
    3029
    3130=== 2. Upgrade the Trac Environment === #UpgradetheTracEnvironment
     
    5352}}}
    5453
    55 Note that this procedure will of course leave your `WikiStart` page intact.
     54Note that this procedure will leave your `WikiStart` page intact.
    5655
    5756=== 4. Resynchronize the Trac Environment Against the Source Code Repository ===
     
    6564=== 5. Refresh static resources ===
    6665
    67 If you've setup web server to give out static resources directly (accessed using /chrome/ URL) then you need to refresh them using the same command:
     66If 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:
    6867{{{
    6968trac-admin /path/to/env deploy /deploy/path
    7069}}}
    71 this will extract static resources and CGI scripts (trac.wsgi, etc) from new Trac version and its plugins into `/deploy/path`.
     70this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    7271
    73 Some web browsers cache the CSS and Javascript file in a strong way, so you'll perhaps need to refresh the cache of the browsers by a force reload (and tell your users to do so!).
     72Some web browsers cache CSS and Javascript files persistently, so you may need to instruct your users to manually erase the contents of their browser's cache.
    7473
    7574=== 6. Steps specific to a given Trac version  ===
     
    7978
    8079===== SQLite v3.x required =====
    81 SQLite v2.x is no longer supported, if you happen to still use a Trac database using this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details.
     80SQLite 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.
     81
     82===== PySqlite 2 required =====
     83PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below).
    8284
    8385===== Multiple Repository Support =====
    84 If you plan to add more repositories to your Trac instance, as this is now possible with the newly introduced multiple repository support, please refer to TracRepositoryAdmin#Migration.
     86The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    8587
    86 This can be of interest even if you only have one repository, as there's now a way to avoid the potentially costly resync check at every request.
     88This may be of interest to users with only one repository, since there's now a way to avoid the potentially costly resync check at every request.
    8789
    8890===== Improved repository synchronization =====
    89 In addition to supporting multiple repositories, a new more efficient method for synchronizing Trac and your repositories was implemented.
     91In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    9092
    9193While 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.
    9294
    9395Note 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, 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.
     96
     97===== Authz permission checking =====
     98The 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).
     99
     100===== Microsecond timestamps =====
     101All 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.
    94102
    95103==== Upgrading from Trac 0.10 to Trac 0.11 ====
     
    100108
    101109===== Trac Macros, Plugins =====
    102 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.
     110The 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.
    103111
    104112===== For FCGI/WSGI/CGI users =====
     
    125133`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.
    126134
     135=== Trac database upgrade ===
     136
     137A known issue in some versions of 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].
     138
     139== Upgrading Python ==
     140
     141Upgrading Python to a newer version will require reinstallation of Python packages: Trac of course; also [http://pypi.python.org/pypi/setuptools easy_install], if you've been using that.  Assuming you're using Subversion, you'll also need to upgrade the Python bindings for svn.
     142
     143=== Windows and Python 2.6 ===
     144
     145If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [http://alagazam.net/ Algazam], which has the Python bindings readily available (see TracSubversion).  The good news is, that works with no tweaking.
    127146
    128147== Changing Database Backend ==