Changes between Version 2 and Version 3 of TracUpgrade

Timestamp:

Jul 30, 2013, 8:39:06 PM (11 years ago)

Author:

trac

Comment:

--

TracUpgrade

@@ -1 @@
-= アップグレードの説明 = #UpgradeInstructions
+= Upgrade Instructions =
 [[TracGuideToc]]
+[[PageOutline(2-4,,inline,unnumbered)]]
 
-[TracEnvironment Trac Environment] をアップグレードする前に Trac-0.11 が使用可能になっている必要があります。このドキュメントでは TracEnvironment をアップグレードするのに必要な手順を説明します。
+== Instructions ==
 
-特に指示がない限り、マイナーバージョンのリリース時には TracEnvironment のアップグレードは必要ありません。
+Typically, there are seven steps involved in upgrading to a newer version of Trac:
 
-== 一般的な手順 == #Instructions
+=== 1. Bring your server off-line
 
-通常、 Trac を新しいバージョンにアップグレードするときに、 4 ステップを踏まなければなりません:
+It 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]. 
 
-=== Trac のコードを更新する === #UpdatetheTracCode
+=== 2. Update the Trac Code === #UpdatetheTracCode
 
-TracInstall または、あなたの OS に合った方法で新しいバージョンの Trac を取得してください。
+Get the new version as described in TracInstall, or your operating system specific procedure.
 
-手で (OS 特有でない) アップグレードをするのであれば、インストールを実行する前に起動中の Trac サーバを停止してください。 "ホット" アップグレードは問題を生じることが多いです。特に Windows では出来ないと考えてください ([http://trac.edgewall.org/ticket/7265 #7265])。
+If 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:
 
-すでに存在する Trac のコードを削除するには、 Python の `lib/site-packages` ディレクトリから `trac` ディレクトリか、 Trac の .egg の古いバージョンを削除します。
-site-packages ディレクトリの位置は OS のシステム、および Python のインストールパスにより異なりますが、一般的には以下の位置にあります:
- * Linux を使用している場合: /usr/lib/python2.X/site-packages
- * Windows を使用している場合: C:\Python2.X\lib\site-packages
- * MacOSX を使用している場合: /Library/Python/2.X/site-packages
+{{{
+# easy_install --upgrade Trac==0.12
+}}}
 
-また、 `share/trac` (正確な位置はプラットフォームに依存しますが一般的にはこの位置です。) ディレクトリ内の `cgi-bin`, `htdocs`, `templates`, `wiki-default` といったディレクトリを削除してもかまいません。 (訳注: 0.11 では、これらのディレクトリは `site-packages/trac` の配下に移動しています)
+If 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]).
 
-このクリーンアップは必須ではありませんが、あとでトラブルシュートを行う場合の切り分けが容易になります。すでに使われていない前のリリースのコードやテンプレートを見るなどという時間の浪費をしたくないのであれば、削除しておく方が楽です。もちろん、ファイルを削除する前にバックアップを作成する方が良いでしょう。
+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 `.egg` files from former versions.
+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 typical:
+ * on Linux: `/usr/lib/python2.X/site-packages`
+ * on Windows: `C:\Python2.X\lib\site-packages`
+ * on MacOSX: `/Library/Python/2.X/site-packages`
 
-webadmin plugin をインストールしていた場合は、アンインストールしてください。今や webadmin plugin は Trac コードベースの一部です。
+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.)
 
-=== TracEnvironment をアップグレードする === #UpgradetheTracEnvironment
+This 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.
 
-アップグレードした Trac がロードされると、アップグレードする必要があるインスタンスが表示されます。アップグレードはオートメーションされたスクリプトを手で実行します。これらのスクリプトでは [TracAdmin trac-admin] を使用します。
+=== 3. Upgrade the Trac Environment === #UpgradetheTracEnvironment
+
+Environment upgrades are not necessary for minor version releases unless otherwise noted. 
+
+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
 }}}
 
-このコマンドはもし TracEnvironment がすでに最新の状態になっているときは、何もしません。
+This command will do nothing if the environment is already up-to-date.
 
-Note: PostgreSQL データベース (訳注: MySQL も) を使用している場合、このコマンドは「 Environment のバックアップは SQLite を使っているときしか出来ない」というメッセージを出力して失敗します。リポジトリとデータベースのバックアップは手動で行う必要があります。その後、アップグレードを行うために次のコマンドを実行してください:
+Note that a backup of your database will be performed automatically prior to the upgrade. 
+This feature is relatively new for the PostgreSQL or MySQL database backends, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:
 {{{
 trac-admin /path/to/projenv upgrade --no-backup
 }}}
 
-カスタム CSS スタイルを使用していたり、 TracEnvironment の templates ディレクトリテンプレートを変更している場合、 Genshi のやり方にコンバートする必要があります。スタイルシートを使用し続けたい場合、 TracInterfaceCustomization#SiteAppearance の手順を読んでください。
+=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
 
-=== Trac ドキュメントを更新する === #UpdatetheTracDocumentation
-
-すべての [TracEnvironment Trac Environment] で、インストールされたバージョンの Trac ドキュメントのコピーを含んでいます。新しくインストールした Trac のドキュメントと同期を取りたいでしょう。 [TracAdmin trac-admin] がドキュメントを更新するコマンドを提供しています:
+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
 }}}
 
-当然このプロシージャはあなたの `WikiStart` ページ (訳注: `InterMapText` も) をまったく変更せず、そのままに残しておきます。
+Note that this procedure will leave your `WikiStart` page intact.
 
-=== サイトテンプレート === #SiteTemplates
-0.11 でテンプレートエンジンが変更されました。 TracInterfaceCustomization を参照してください。
 
-=== Trac マクロプラグイン === #TracMacrosPlugins
-!ClearSilver と HDF が使用されなくなったことで、古いスタイルの Wiki マクロ は使用できなくなります。そのため Trac マクロを適応させる必要があるでしょう; 新しいスタイルのマクロに変更する必要があれば WikiMacros を参照してください。新しいスタイルにコンバートした後、配置するディレクトリは wiki-macros ではなく、 plugins を使用してください。 wiki-macros ディレクトリからマクロやプラグインを探すことはもうありません。
+=== 5. Refresh static resources ===
 
-=== CGI 利用者向けの注意 === #ForCGIusers
+If 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:
+{{{
+trac-admin /path/to/env deploy /deploy/path
+}}}
+this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
 
-CGI で Trac を起動している場合、以下のコマンドを実行して trac.cgi ファイルを取得してください:
+Some web browsers (IE, Opera) cache CSS and Javascript files aggressively, so you may need to instruct your users to manually erase the contents of their browser's cache, a forced refreshed (`<F5>`) should be enough.
+{{{#!comment
+Remove above note once #9936 is fixed.
+}}}
+
+=== 6. Steps specific to a given Trac version  ===
+==== Upgrading from Trac 0.12 to Trac 1.0 ==== #to1.0
+
+The 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:
+{{{
+[components]
+tracopt.versioncontrol.svn.* = enabled
+}}}
+The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
+
+Another step in the automatic upgrade will change the way the attachments are stored. If you're a bit paranoid, you might want to take a backup of the `attachments` directory before upgrading (but if you are, you already did a full copy of the environment, no?). In case the `attachments` directory contains some files which are //not// attachments, the last step of the migration to the new layout will fail: the deletion of the now unused `attachments` directory can't be done if there are still files and folders in it. You may ignore this error, but better go have a look to these files, move them elsewhere and remove the `attachments` directory manually to cleanup the environment. The attachments themselves are now all located in your environment below the `files/attachments` directory.
+
+
+==== Upgrading from Trac 0.11 to Trac 0.12 ====
+
+===== Python 2.3 no longer supported =====
+The minimum supported version of python is now 2.4
+
+===== SQLite v3.x required =====
+SQLite 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.
+
+===== PySqlite 2 required =====
+PySqlite 1.1.x is no longer supported. Please install 2.5.5 or later if possible (see [#Tracdatabaseupgrade Trac database upgrade] below).
+
+===== Multiple Repository Support =====
+The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
+
+This 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.
+
+===== Resynchronize the Trac Environment Against the Source Code Repository =====
+
+Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[http://trac.edgewall.org/ticket/6120 No changeset ??? in the repository]" while browsing the source through the Trac interface:
+
+{{{
+trac-admin /path/to/projenv repository resync '*'
+}}}
+
+===== Improved repository synchronization =====
+In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
+
+While 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.
+
+Note 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.
+
+===== Authz permission checking =====
+The 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).
+
+===== Microsecond timestamps =====
+All 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.
+
+==== Upgrading from Trac 0.10 to Trac 0.11 ====
+===== Site Templates and Styles =====
+The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
+
+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.
+
+===== 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 [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.
+
+===== For FCGI/WSGI/CGI users =====
+For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
 {{{
 trac-admin /path/to/env deploy /deploy/directory/path
 }}}
 
-このコマンドでは、デプロイ用ディレクトリを作成します。デプロイ用ディレクトリには `cgi-bin` と `htdocs` の二つのサブディレクトリが含まれています。 Apache の `httpd.conf` を新しい `trac.cgi` と `htdocs` の場所に更新してください。
+This 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.
 
-=== Web サーバを再起動する === #RestarttheWebServer
-[wiki:TracCgi CGI] 以外で起動している場合は、 Web サーバを再起動して、新しい Trac コードをリロードしてください。
+===== Web Admin plugin integrated =====
+If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
 
+=== 7. Restart the Web Server === #RestarttheWebServer
 
-== 既知の問題 == #KnownIssues
-=== 複数プロジェクトのホストに関して === #parentdir
-複数のプロジェクトをホストした場合に、配下のプロジェクトのうち一つのプロジェクトで、プラグインの一つが動作していないとき、配下のすべてのプロジェクトではそのプラグインは動作していません。
-=== コアモジュールがロードされない === #somecoremoduleswontload
-Windows で Python 2.3 を使用している場合、最初にアンインストールを行わずにアップグレードすると時々発生します。
-いくつかのモジュールは、以前はキャピタライズされていましたが、小文字のみに変更されました (例えば、 trac/About.py が trac/about.py に変更されるなど)。以下のようなメッセージが Trac のログに出てくる場合:
-{{{
-ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
-}}}
-`Lib/site-packages/trac` ディレクトリを削除してから、再インストールしてください。
-=== Wiki Upgrade === WikiUpgrade
-`trac-admin` はページを削除しません。バージョン 0.10 では存在し、バージョン 0.11 では存在しないページはそのまま残ります。 (0.11 開発中に存在した !TracWikiMacros など)
+If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.
 
-== データベースの変更 == #ChangingDatabaseBackend
-=== SQLite から PostgreSQL へ === #SQLitetoPostgreSQL
+== Known Issues ==
 
-[http://trac-hacks.org trac-hacks.org] の [http://trac-hacks.org/wiki/SqliteToPgScript sqlite2pg] は SQLite のデータベースを PostgreSQL に移行するためのサポートをするスクリプトです。 
+Things you should pay attention to, while upgrading.
 
-== より古いバージョン == #OlderVersions
+=== Customized Templates
 
-さらに前のバージョンからのアップグレードについては [http://trac.edgewall.org/wiki/0.10/TracUpgrade 0.10/TracUpgrade] をまずは参照してください。
+Trac supports customization of its Genshi templates by placing copies of the templates in the `<env>/templates` folder of your [TracEnvironment environment] or in a common location specified in the [[TracIni#GlobalConfiguration| [inherit] templates_dir]] configuration setting. If you choose to do so, be wary that you will need to repeat your changes manually on a copy of the new templates when you upgrade to a new release of Trac (even a minor one), as the templates will likely evolve. So keep a diff around ;-)
 
-Note: Trac 0.11 から Trac 0.10.4 や 0.10.5 にダウングレードするには、手作業が必要になります:
-{{{
-$ sqlite3 db/trac.db "update system set value=20 where name='database_version'"
-}}}
-(あとで再度、正常にアップグレードすることができます)
+The 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 TracDev/ApiChanges pages.
+
+=== !ZipImportError ===
+
+Due 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.
+See [trac:#7014] for details.
+
+=== Wiki Upgrade ===
+`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.
+
+=== Trac database upgrade ===
+
+A 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].
+
+=== 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.
+
+== Related topics
+
+=== Upgrading Python ===
+
+Upgrading 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.
+
+==== Windows and Python 2.6 ====
+
+If 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 TracSubversion).  The good news is, that works with no tweaking.
+
+=== Changing Database Backend ===
+==== SQLite to PostgreSQL ====
+
+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
+
+=== Upgrading from older versions of Trac === #OlderVersions
+
+For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions].
 
 -----