| 4 | | Trac は Python で書かれており、データベースとして [http://sqlite.org/ SQLite], [http://postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL] のどれかが必要です。 Trac は HTML レンダリングのために [http://genshi.edgewall.org Genshi] テンプレートシステムを使用します。 |
| 5 | | |
| 6 | | バージョン 0.12 以降で Trac はローカライズされているため、自分が普段使っている言語に翻訳されているかもしれません。 Trac のインタフェースで別の言語を使用したい場合は、任意のパッケージである [#OtherPythonPackages Babel] をインストールする必要があります。ローカライズの機能を使用するための手順については、このページに記載する [#InstallingTrac Trac のインストール] セクションを参照してください。 Babal がない状態では、通常はデフォルトの英語版が使用されます。 |
| 7 | | |
| 8 | | 新しい言語での翻訳の作成や、すでにある言語での翻訳のエンハンスをコントリビュートした場合は [[http://trac.edgewall.org/wiki/TracL10N TracL10N]] を見てみてください。 (訳注: 日本語の翻訳はすでにコントリビュートされています) |
| 9 | | |
| 10 | | Trac のインストールとセットアップに対する一般的な手順を以下に示します。 Trac を特定のシステムにインストールする手順は Trac Project サイトの [http://trac.edgewall.org/wiki/TracInstallPlatforms TracInstallPlatforms] にありますが、 '''まず最初に以下の一般的な手順を読み通して''' タスクの関係を確実に理解してください。 |
| 11 | | |
| 12 | | [[PageOutline(2-3,インストール手順,inline)]] |
| 13 | | |
| 14 | | == 依存関係 == #Dependencies |
| 15 | | === 必須の依存関係 === #MandatoryDependencies |
| 16 | | Trac をインストールするためには以下のソフトウェアパッケージがインストールされていなければなりません: |
| 17 | | |
| 18 | | * [http://www.python.org/ Python], 2.4 以上 3.0 未満 |
| 19 | | (Pyhton 2.3 のサポートは、このリリース (訳注: 0.12) で打ち切られました) |
| 20 | | * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], 0.6 以上 |
| 21 | | * [http://genshi.edgewall.org/wiki/Download Genshi], 0.6 以上 |
| 22 | | |
| 23 | | また、データベースと、それに対応する Python のバインディングが必要です。 |
| 24 | | データベースは SQLite, PostgreSQL, MySQL のいずれかが使用できます。 |
| 25 | | |
| 26 | | ==== SQLite の場合 ==== #ForSQLite |
| 27 | | |
| 28 | | Python 2.5 か 2.6 の場合は、必要なライブラリは同梱されています。 |
| 29 | | |
| 30 | | Python 2.4 の場合、 pysqlite が必要です。 pysqlite は |
| 31 | | [http://code.google.com/p/pysqlite/downloads/list google code] から Windows |
| 32 | | インストーラやソースからのビルド用の tar.gz アーカイブがダウンロードできます: |
| | 4 | Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system. |
| | 5 | |
| | 6 | Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default english version, as usual. |
| | 7 | |
| | 8 | If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]]. |
| | 9 | |
| | 10 | What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved. |
| | 11 | |
| | 12 | [[PageOutline(2-3,Installation Steps,inline)]] |
| | 13 | |
| | 14 | == Dependencies == |
| | 15 | === Mandatory Dependencies |
| | 16 | To install Trac, the following software packages must be installed: |
| | 17 | |
| | 18 | * [http://www.python.org/ Python], version >= 2.5 and < 3.0 |
| | 19 | (note that we dropped the support for Python 2.4 in this release) |
| | 20 | * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute] |
| | 21 | * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well) |
| | 22 | |
| | 23 | You also need a database system and the corresponding python bindings. |
| | 24 | The database can be either SQLite, PostgreSQL or MySQL. |
| | 25 | |
| | 26 | ==== For the SQLite database #ForSQLite |
| | 27 | |
| | 28 | As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). |
| | 29 | |
| | 30 | However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from |
| | 31 | [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows |
| | 32 | installers or the `tar.gz` archive for building from source: |
| 52 | | 詳しくは [http://trac.edgewall.org/wiki/DatabaseBackend#Postgresql DatabaseBackend] を参照してください。 |
| 53 | | |
| 54 | | |
| 55 | | ==== MySQL の場合 ==== #ForMySQL |
| 56 | | |
| 57 | | Trac は以下のガイドラインで、 MySQL でも良好に動作するようになりました。 |
| 58 | | |
| 59 | | * [http://mysql.com/ MySQL], 5.0 以降 |
| 60 | | * [http://sf.net/projects/mysql-python MySQLdb], 1.2.2 以降 |
| 61 | | |
| 62 | | '''非常に''' 重要なことが記載されているので、データベースを作成するときに [http://trac.edgewall.org/wiki/MySqlDb MySqlDb] のページを注意深く読んでください。 |
| 63 | | |
| 64 | | === 任意の依存関係 === #OptionalDependencies |
| 65 | | |
| 66 | | ==== バージョン管理システム ==== #VersionControlSystem |
| | 55 | See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. |
| | 56 | |
| | 57 | |
| | 58 | ==== For the MySQL database #ForMySQL |
| | 59 | |
| | 60 | Trac can now work quite well with MySQL, provided you follow the guidelines. |
| | 61 | |
| | 62 | * [http://mysql.com/ MySQL], version 5.0 or later |
| | 63 | * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later |
| | 64 | |
| | 65 | It is '''very''' important to read carefully the [trac:MySqlDb] page before creating the database. |
| | 66 | |
| | 67 | === Optional Dependencies |
| | 68 | |
| | 69 | ==== Version Control System ==== |
| 69 | | * [http://subversion.apache.org/ Subversion], 1.5.x または 1.6.x と '''''対応する''''' Python バインディング。 1.2.4, 1.3.2, 1.4.2 のような 1.0 以降の古いバージョンも、今のところ動作します。トラブルシューティングの情報が [http://trac.edgewall.org/wiki/TracSubversion#Troubleshooting TracSubversion] のページに記載されていますので、確認してみてください。 |
| 70 | | |
| 71 | | 主要なプラットフォーム向けに [http://subversion.apache.org/packages.html コンパイル済みの SWIG バインディング] が用意されていますので、通常はこれを使ってください。 Trac は [http://pysvn.tigris.org/ Pysvn] のような新しい `ctype` 形式のバインディングでは '''動作しません'''。 |
| 72 | | |
| 73 | | |
| 74 | | '''重要な Note:''' Subversion を使用するなら Trac を '''同じマシン''' にインストールする必要があります。リモートリポジトリは現在サポートされていません。 |
| 75 | | |
| 76 | | |
| 77 | | ===== その他のバージョン管理システム ===== #Others |
| 78 | | |
| 79 | | Subversion 以外のバージョン管理システムのサポートはサードパーティから提供されます。 [http://trac.edgewall.org/wiki/PluginList PluginList] および [http://trac.edgewall.org/wiki/VersioningSystemBackend VersioningSystemBackend] を参照してください。 |
| 80 | | |
| 81 | | ==== Web サーバ ==== #WebServer |
| 82 | | Trac にはサーバ機能が組み込まれているので、 Web サーバは必須ではありません。このページに下にある [#RunningtheStandaloneServer スタンドアロンサーバの起動] セクションを参照してください。 |
| 83 | | |
| 84 | | Trac は下記の要件を満たす Web サーバで動作します。 |
| 85 | | * [http://httpd.apache.org/ Apache] との組み合わせで |
| 86 | | - [http://code.google.com/p/modwsgi/ mod_wsgi], [wiki:TracModWSGI] および |
| 87 | | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac を参照 |
| 88 | | - [http://modpython.org/ mod_python 3.3.1], TracModPython を参照 |
| 89 | | * [http://www.fastcgi.com/ FastCGI] が使用可能な Web サーバ (TracFastCgi を参照) |
| 90 | | * [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP] が使用可能な Web |
| 91 | | サーバ ([http://trac.edgewall.org/wiki/TracOnWindowsIisAjp TracOnWindowsIisAjp] を参照) |
| 92 | | * CGI が使用可能な Web サーバ (TracCgi を参照), '''しかし Trac を CGI スクリプトとして使用することは |
| 93 | | 全く推奨されていません''' ので、上に挙げた方法を選択するようにしてください。 |
| | 72 | * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. |
| | 73 | |
| | 74 | There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.) |
| | 75 | |
| | 76 | Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. |
| | 77 | |
| | 78 | |
| | 79 | '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. |
| | 80 | |
| | 81 | |
| | 82 | ===== Others ===== |
| | 83 | |
| | 84 | Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. |
| | 85 | |
| | 86 | ==== Web Server ==== |
| | 87 | A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. |
| | 88 | |
| | 89 | Alternatively you configure Trac to run in any of the following environments. |
| | 90 | * [http://httpd.apache.org/ Apache] with |
| | 91 | - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and |
| | 92 | http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac |
| | 93 | - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython) |
| | 94 | * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) |
| | 95 | * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web |
| | 96 | server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) |
| | 97 | * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script |
| | 98 | is highly discouraged''', better use one of the previous options. |
| 96 | | ==== その他の Python パッケージ ==== #OtherPythonPackages |
| 97 | | |
| 98 | | * [http://babel.edgewall.org Babel], 0.9.5 以上。 |
| 99 | | ローカライズの機能を使用する場合は必要。 |
| 100 | | * [http://docutils.sourceforge.net/ docutils], 0.3.9 以上。 |
| 101 | | WikiRestructuredText を使用する場合は必要。 |
| 102 | | * [http://pygments.pocoo.org Pygments], |
| 103 | | [wiki:TracSyntaxColoring シンタックスハイライト] を使用する場合は必要。 |
| 104 | | [http://silvercity.sourceforge.net/ SilverCity] や |
| 105 | | [http://gnu.org/software/enscript/enscript.html Enscript] も、今のところ使用できますが、 |
| 106 | | サポートを打ち切る予定なので、 Pygments を使用してください。 |
| 107 | | * [http://pytz.sf.net pytz], タイムゾーンの完全なリストを取得する場合に必要。 |
| 108 | | pytz がない場合、 Trac は内部で定義している |
| 109 | | 短いタイムゾーンの実装にフォールバックします。 |
| 110 | | |
| 111 | | '''Attention''': これらの依存関係は様々なバージョンで必ずしも置き換えできるとは限らないので、上記のバージョン番号に注意してください。 Trac を動かす上で問題が発生した場合は [http://trac.edgewall.org/wiki/MailingList メーリングリスト] や [http://trac.edgewall.org/wiki/IrcChannel IRC チャネル] で質問をする前にすべての依存関係を再度確認してください。 |
| 112 | | |
| 113 | | これらのパッケージのドキュメンテーションを参照して、それらが最も上手にインストールできる方法を探してください。また [http://trac.edgewall.org/wiki/TracInstallPlatforms プラットフォーム特有の説明] の多くに、これらの依存関係のインストール方法が記述されています。しかしながら [http://trac.edgewall.org/wiki/TracInstallPlatforms プラットフォーム特有の説明] の情報はあなたがインストールしている Trac より古い バージョンについての説明があることを覚えておいてください (なんと Trac 0.8 に関する説明をしているページもあります)。 |
| 114 | | |
| 115 | | |
| 116 | | == Trac のインストール == #InstallingTrac |
| 117 | | === `easy_install` を使用したインストール ===#Usingeasy_install |
| 118 | | Trac をインストールする方法のひとつに `setuptools` の利用があります。 |
| 119 | | setuptools を使用すると、 Trac を Subversion リポジトリからインストールすることもできます; |
| 120 | | |
| 121 | | 例: |
| 122 | | |
| 123 | | - Trac 0.12 をインストールする: |
| | 101 | ==== Other Python Packages ==== |
| | 102 | |
| | 103 | * [http://babel.edgewall.org Babel], version >= 0.9.5, |
| | 104 | needed for localization support (unreleased version 1.0dev should work as well) |
| | 105 | * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 |
| | 106 | for WikiRestructuredText. |
| | 107 | * [http://pygments.pocoo.org Pygments] for |
| | 108 | [wiki:TracSyntaxColoring syntax highlighting]. |
| | 109 | [http://silvercity.sourceforge.net/ SilverCity] and/or |
| | 110 | [http://gnu.org/software/enscript/enscript.html Enscript] may still be used |
| | 111 | but are deprecated and you really should be using Pygments. |
| | 112 | * [http://pytz.sf.net pytz] to get a complete list of time zones, |
| | 113 | otherwise Trac will fall back on a shorter list from |
| | 114 | an internal time zone implementation. |
| | 115 | |
| | 116 | '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel]. |
| | 117 | |
| | 118 | Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!). |
| | 119 | |
| | 120 | |
| | 121 | == Installing Trac == |
| | 122 | === Using `easy_install` |
| | 123 | One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. |
| | 124 | With setuptools you can install Trac from the subversion repository; |
| | 125 | |
| | 126 | A few examples: |
| | 127 | |
| | 128 | - install Trac 1.0: |
| 151 | | pip では OS 固有のヘッダファイルなとが整備されているため、 PostgreSQL (libpg-dev) や MySQL (libmysqlclient-dev) へのバインディングも自動でビルドされます。 |
| 152 | | |
| 153 | | また pip は (Genshi, Pygments などの) 依存関係を解決し、 pypi.python.org から最新のパッケージをダウンロードして、 /opt/user/trac の配下にインストールするところまで自動化されています。 |
| 154 | | |
| 155 | | すべてのコマンド (tracd, trac-admin) は /opt/user/trac/bin の配下にインストールされます。 mod_python (!PythonHandler ディレクティブを使用する場合) や mod_wsgi (!WSGIDaemonProcess ディレクティブを使用する場合) などのファイルも配置されます。 |
| 156 | | |
| 157 | | 加えて、 Trac プラグインのうちのいくつか ([http://pypi.python.org/pypi?:action=search&term=trac&submit=search ここ] で一覧を見ることができます) も pip からインストールすることが可能です。 |
| 158 | | |
| 159 | | |
| 160 | | |
| 161 | | === ソースからのインストール === #Fromsource |
| 162 | | もちろんのことながら、ソースコードディレクトリのトップで行う Python の伝統的な setup も動作します。 |
| 163 | | |
| 164 | | ソースはリリースに一致する .tar.gz や .zip の形式 (Trac-0.12.tar.gz など) で取得できます。また、リポジトリから直接取得することもできます (詳しくは [http://trac.edgewall.org/wiki/SubversionRepository SubversionRepository] を参照してください)。 |
| | 156 | Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. |
| | 157 | |
| | 158 | pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`. |
| | 159 | |
| | 160 | All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive) |
| | 161 | |
| | 162 | Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. |
| | 163 | |
| | 164 | |
| | 165 | |
| | 166 | === From source |
| | 167 | Of course, using the python-typical setup at the top of the source directory also works. |
| | 168 | |
| | 169 | You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details). |
| 214 | | [TracAdmin trac-admin] は、プロジェクトの名前や [TracEnvironment#DatabaseConnectionStrings データベース接続文字列] など、 Environment を新規作成するために必要な情報を入力するためのプロンプトを表示します。これらの設定項目について特に変更が必要ない場合は、単に `<Enter>` を押下すると、デフォルト値が使用されます。 |
| 215 | | |
| 216 | | データベース接続文字列のデフォルトは SQLite が使用されます。 SQLite がインストールされている場合は、他の設定は不要です。 |
| 217 | | 他の [http://trac.edgewall.org/wiki/DatabaseBackend データベースバックエンド] を使用する場合は、あらかじめデータベースが使用可能な状態にしておかねばなりません。 |
| 218 | | |
| 219 | | 0.12 以降で Trac は、新しい Environment の作成時に [TracEnvironment#SourceCodeRepository ソースコードリポジトリ] を尋ねないようになりました。リポジトリを後で [TracRepositoryAdmin 追加する] までの間、バージョン管理のサポートは無効化されます。 |
| 220 | | |
| 221 | | また、 ここで指定した値は [TracIni conf/trac.ini] 設定ファイルを直接編集することで後から変更できます。 |
| 222 | | |
| 223 | | 最後に、 Web のフロントエンドを実行しているユーザアカウントは、 Environment のディレクトリと、その中のすべてのファイルに対する書き込み権限が必要です。 `trac-admin ... initenv` の実行を該当するユーザで実行した場合は、この作業は不要ですが、そうでない場合、ただしユーザに権限を付与する作業が必要になります。たとえば Linux で `apache` ユーザ `apache` グループで Web サーバを起動する場合は: |
| | 219 | [TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value. |
| | 220 | |
| | 221 | Using the default database connection string in particular will always work as long as you have SQLite installed. |
| | 222 | For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. |
| | 223 | |
| | 224 | Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it. |
| | 225 | |
| | 226 | Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. |
| | 227 | |
| | 228 | Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter: |
| 240 | | == Web サーバ上での Trac の起動 == #RunningTraconaWebServer |
| 241 | | |
| 242 | | Trac に "真の" Web サーバから接続するには、いくつかの方法があります: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi], [wiki:TracModPython mod_python] です。まともな性能を出すには FastCGI か mod_wsgi のどちらかを使用することが推奨されます。 |
| 243 | | |
| 244 | | Trac では [http://trac.edgewall.org/wiki/TracOnWindowsIisAjp AJP] も使用できます。これを使うと IIS とも接続することができます。 |
| 245 | | |
| 246 | | ==== Trac の cgi-bin ディレクトリを生成する ==== #GeneratingtheTraccgi-bindirectory |
| 247 | | |
| 248 | | Trac を FastCGI などで正しく機能させるには、 FastCGI であれば `trac.fcgi` ファイル、 mod_wsgi であれば `trac.wsgi` ファイルが必要となります。これらのファイルは適切な Python コードをロードする Python スクリプトです。 [wiki:TracAdmin trac-admin] コマンドの `deploy` オプションを使用することで生成できます。 |
| 249 | | |
| 250 | | 若干の「卵が先か鶏が先か」問題があります。 [wiki:TracAdmin trac-admin] コマンドが機能するためには Environment が必要なのですが、 deploy には既に存在するディレクトリは使用できません。これに起因して、 Environment は depoly するディレクトリのサブディレクトリを使用することができません。この制限を回避するには次のようにすます: |
| | 252 | === Running Trac on a Web Server === |
| | 253 | |
| | 254 | Trac provides various options for connecting to a "real" web server: |
| | 255 | - [wiki:TracFastCgi FastCGI] |
| | 256 | - [wiki:TracModWSGI mod_wsgi] |
| | 257 | - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// |
| | 258 | - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// |
| | 259 | |
| | 260 | Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc. |
| | 261 | |
| | 262 | ==== Generating the Trac cgi-bin directory ==== #cgi-bin |
| | 263 | |
| | 264 | In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin]. |
| | 265 | |
| | 266 | There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this: |
| 258 | | ==== プラグインキャッシュの設定 ==== #SettingupthePluginCache |
| 259 | | |
| 260 | | Python プラグインの中にはキャッシュディレクトリを必要とするものがあります。デフォルトではキャッシュディレクトリは、現在のユーザのホームディレクトリに置かれます。 Trac を Web サーバで動作させている場合、ホームディレクトリを持たない専用ユーザであることが多く (強く推奨します)、プラグインの起動が妨げられることがあります。キャッシュディレクトリの場所を変更するには、環境変数 PYTHON_EGG_CACHE を設定してください。環境変数を設定する方法の詳細は使用しているサーバのドキュメントから参照してください。 |
| 261 | | |
| 262 | | == 認証の構成 == #ConfiguringAuthentication |
| 263 | | |
| 264 | | 認証のためのユーザアカウントを追加、削除、構成する方法は Trac を起動する方法により異なります。基本的な手順は TracCgi ページの [wiki:TracCgi#AddingAuthentication "認証を追加する"] セクションで説明されていますが、各フロントエンドのための認証をセットアップする方法は、以下のいずれかを参照してください: |
| 265 | | |
| 266 | | * スタンドアロンサーバ `tracd` を使用する場合は TracStandalone |
| 267 | | * CGI か FastCGI を使用する場合は TracCgi |
| 268 | | * Apache の mod_wsgi を使用する場合は [wiki:TracModWSGI] |
| 269 | | * Apache の mod_python を使用する場合は TracModPython |
| 270 | | |
| 271 | | |
| 272 | | == SVN のチェンジセットを Trac のチケットに自動リンクする方法 == #AutomaticreferencetotheSVNchangesetsinTractickets |
| 273 | | |
| 274 | | 変更をリポジトリにコミットした時に、チェンジセットへのリンクをチケットのコメントに自動で追加するように SVN を設定することができます。コミットメッセージには以下に示すいずれかの書式が含まれていなければなりません: |
| 275 | | * '''Refs !#123''' - このチェンジセットへのリンクをチケット !#123 に追加します |
| 276 | | * '''Fixes !#123''' - このチェンジセットへのリンクをチケット !#123 に追加し、チケットを ''fixed'' でクローズします。 |
| 277 | | |
| 278 | | この機能を使用するためには post-commit フックを [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin] に記載したリポジトリにインストールし、 commit updater コンポーネントを有効にせねばなりません。コンポーネントの有効化は、 [wiki:TracIni#components-section trac.ini] ファイルの `[components]` セクションに下記記述を追加するか、 "プラグイン" (英語版では "Plugins") 管理パネルから設定します。 |
| | 274 | |
| | 275 | ==== Mapping Static Resources ==== |
| | 276 | |
| | 277 | Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance). |
| | 278 | |
| | 279 | Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself. |
| | 280 | |
| | 281 | There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything. |
| | 282 | |
| | 283 | Note that in order to get those static resources on the filesystem, you need first to extract the relevant resources from Trac using the [TracAdmin trac-admin]` <environment> deploy` command: |
| | 284 | [[TracAdminHelp(deploy)]] |
| | 285 | |
| | 286 | The target `<directory>` will then contain an `htdocs` directory with: |
| | 287 | - `site/` - a copy of the environment's directory `htdocs/` |
| | 288 | - `common/` - the static resources of Trac itself |
| | 289 | - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment |
| | 290 | |
| | 291 | ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example |
| | 292 | |
| | 293 | Assuming the deployment has been done this way: |
| | 294 | {{{ |
| | 295 | $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common |
| | 296 | }}} |
| | 297 | |
| | 298 | Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment: |
| | 299 | {{{ |
| | 300 | Alias /trac/chrome/common /path/to/trac/htdocs/common |
| | 301 | Alias /trac/chrome/site /path/to/trac/htdocs/site |
| | 302 | |
| | 303 | <Directory "/path/to/www/trac/htdocs"> |
| | 304 | Order allow,deny |
| | 305 | Allow from all |
| | 306 | </Directory> |
| | 307 | }}} |
| | 308 | |
| | 309 | If using mod_python, you might want to add this too (otherwise, the alias will be ignored): |
| | 310 | {{{ |
| | 311 | <Location "/trac/chrome/common/"> |
| | 312 | SetHandler None |
| | 313 | </Location> |
| | 314 | }}} |
| | 315 | |
| | 316 | Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources. |
| | 317 | |
| | 318 | Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation): |
| | 319 | {{{ |
| | 320 | Alias /trac/chrome/site /path/to/projectenv/htdocs |
| | 321 | |
| | 322 | <Directory "/path/to/projectenv/htdocs"> |
| | 323 | Order allow,deny |
| | 324 | Allow from all |
| | 325 | </Directory> |
| | 326 | }}} |
| | 327 | |
| | 328 | Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting: |
| | 329 | {{{ |
| | 330 | [trac] |
| | 331 | htdocs_location = http://static.example.org/trac-common/ |
| | 332 | }}} |
| | 333 | Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less]). |
| | 334 | |
| | 335 | Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server: |
| | 336 | {{{ |
| | 337 | $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common |
| | 338 | }}} |
| | 339 | |
| | 340 | |
| | 341 | ==== Setting up the Plugin Cache ==== |
| | 342 | |
| | 343 | Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHE environment variable. Refer to your server documentation for detailed instructions on how to set environment variables. |
| | 344 | |
| | 345 | == Configuring Authentication == |
| | 346 | |
| | 347 | Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the REMOTE_USER variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info. |
| | 348 | |
| | 349 | The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. |
| | 350 | |
| | 351 | Please refer to one of the following sections: |
| | 352 | * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. |
| | 353 | * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`. |
| | 354 | * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) |
| | 355 | |
| | 356 | == Granting admin rights to the admin user |
| | 357 | Grant admin rights to user admin: |
| | 358 | {{{ |
| | 359 | $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN |
| | 360 | }}} |
| | 361 | This user will have an "Admin" entry menu that will allow you to admin your trac project. |
| | 362 | |
| | 363 | == Finishing the install |
| | 364 | |
| | 365 | === Automatic reference to the SVN changesets in Trac tickets === |
| | 366 | |
| | 367 | You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas: |
| | 368 | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| | 369 | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| | 370 | |
| | 371 | This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel. |
