close Warning: Can't synchronize with repository "(default)" (/var/svn/mioproject does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
Jul 30, 2013, 8:39:06 PM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v2 v3  
    1 = Trac インストールガイド 0.11 = #TracInstallationGuidefor0.11
     1= Trac Installation Guide for 1.0 =
    22[[TracGuideToc]]
    33
    4 Trac は Python で書かれており、データベースとして [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL] のどれかが必要です。 Trac は HTML レンダリングのために [http://genshi.edgewall.org Genshi] テンプレートシステムを使用します。
    5 
    6 Trac のインストールとセットアップに対する一般的な手順を以下に示します。 Trac を特定のシステムにインストールする手順は Trac Project サイトの [http://trac.edgewall.org/wiki/TracInstallPlatforms TracInstallPlatforms] にありますが、 '''まず最初に以下の一般的な手順を読み通して''' タスクの関係を確実に理解してください。
    7 
    8 == 簡単な方法 - リリースバージョン向け == #Short-Installareleasedversion
    9 クイックインストールをするためには [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install], SQlite-3.3.4 がすでにインストールされていなければなりません (各バージョンは、より新しいものでも可)。 (Genshi をビルドするのであれば、 python-dev (訳注: のような Python のビルド環境パッケージ) も必要になります)
    10 {{{
    11 sudo easy_install Trac
    12 }}}
    13 
    14 == インストール条件 == #Requirements
    15 Trac を動作させるためのハードウェア要件は、当然のことながらデータ (Wiki ページ, チケット, リビジョンの数) のボリュームやトラフィックに強く依存します。とても小さなプロジェクトであれば、 500MHz のプロセッサ一つに 128MB の RAM でも SQLite を使って充分動作させられます。高速なハードディスクであればさらに動作が快適になるでしょう。
    16 
    17 Trac をインストールするためには以下のソフトウェアパッケージがインストールされていなければなりません:
    18 
    19  * [http://www.python.org/ Python] 2.3 以上
    20    * XML 関連が組み込まれた mod_python を使用する場合、 python-2.5 を使用してください。 expat モジュールがネームスペース化されているので、 apache のクラッシュが引き起こされることがなくなります。 (詳細は [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash ここ] を参照してください) 。
    21    * RPM ベースのシステムでは、 `python-devel` と `python-xml` パッケージが必要になるかもしれません。
    22    * 注意事項を参照してください。 [http://trac.edgewall.org/wiki/TracOnWindows/Python2.5 "TracOnWindows/Python2.5"]
    23  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools] 0.6 以上
    24  * [http://genshi.edgewall.org/wiki/Download Genshi] 0.5 以上 (バージョン 0.4.1 以上という記述は 0.11 のリリース候補以前の場合でした)
    25  * データベースシステムと対応する Python ドライバが必要です。
    26    データベースは SQLite, PostgreSQL, ''MySQL (実験的)'' のどれかが使えます。
    27  * プラグインが必要とする場合は [http://www.clearsilver.net/ ClearSilver] が必要です。
    28 
    29 ==== SQLiteの場合 ==== #ForSQLite
    30 
    31  * [http://www.sqlite.org/ SQLite] 3.3.4 以上を推奨します (Note: Python 2.5.2 には同梱されています)。
    32  * Python-2.5 を使用しないなら [http://pysqlite.org/ PySQLite] が必要です (2.3.2 を推奨します)。 SQLite 2.x を使用する場合 PySQLite version 1.x 、 SQLite 3.x を使用する場合 PySQLite version 2.x がそれぞれ必要です。 詳細は [http://trac.edgewall.org/wiki/PySqlite PySqlite] を参照してください。
    33 
    34 ''Note: 'contrib/trac-post-commit-hook' を使用する場合、 Trac は 0.9 以降、 PySQLite は 2.x が必要です。
    35 
    36 ''Note: Mac OS X のユーザは注意してください; Apple が提供している SQLite は AFP や SMB のようなネットワークファイルシステムでのがいるロックを行うための追加コードが含まれています。このコードは現在のメインラインのソース (3.3.6) では存在しませんので、ソースから SQLite をビルドした場合にこのようなファイルシステムでは正しく機能しないでしょう - 通常は "{{{database is locked}}}" というエラーが発生します。 Apple のコードをベースにした 3.3.6 向けの [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ パッチ] があります。また、 Apple から提供されている別のバージョン (今のところ 3.1.3) を使用するのがおそらく最も良いでしょう。''
    37 
    38 ==== PostgreSQLの場合 ==== #ForPostgreSQL
    39 
    40  * [http://www.postgresql.org/ PostgreSQL]
    41  * [http://initd.org/projects/psycopg2 psycopg2]
    42  * See [http://trac.edgewall.org/wiki/DatabaseBackend#Postgresql DatabaseBackend]
    43 
    44 '''Warning''': PostgreSQL 8.3 は厳密な型チェックメカニズムを採用しています。 Trac で PostgreSQL の バージョン 8.3 を使用するには、 [http://trac.edgewall.org/changeset/6512 trac-0.11] 以降でなければなりません。
    45 
    46 ==== MySQLの場合 ==== #ForMySQL
    47 
    48 '''Warning''': MySQL のサポートは今のところ ''まだ'' 実験段階です。 環境によっては動作しますが、特に unicode の使用と、リポジトリキャッシュのキー長に関して、いくつかの問題が残っています。より詳細な情報は [http://trac.edgewall.org/wiki/MySqlDb MySqlDb] を参照してください。
    49 
    50  * [http://mysql.com/ MySQL] 4.1 以上
    51  * [http://sf.net/projects/mysql-python MySQLdb] 1.2.1 以上
    52 
    53 == 非必須の条件 == #OptionalRequirements
    54 
    55 ==== バージョン管理システム ==== #VersionControlSystem
    56 
    57 '''Please note:''' Subversion を使用するなら Trac を同じマシンにインストールする必要があります。リモートリポジトリは現在サポートされていません。
    58 
    59  * [http://subversion.tigris.org/ Subversion] 1.0 以上 (1.2.4, 1.3.2, 1.4.2 のいずれかが推奨されます) と '''''対応する''''' Python バインディングに対応しています。トラブルシューティングには [http://trac.edgewall.org/wiki///trac.edgewall.org/wiki/TracSubversion TracSubversion] を参照してください。
    60    * Trac は Subversion のディストリビューションに含まれる [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] バインディングを使用します。 [http://pysvn.tigris.org/ PySVN] では '''ありません''' (PySVN は時々、標準の SWIG バインディングと混同されることがあります)。
    61    * SWIG バインディングを含まない Subversion が既にインストールされている場合、 Unix であれば `make swig-py` と `make install-swig-py` による Subversion の再構成が必要です。
    62    * Win32 の場合、 [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] から取得してください。
    63  * サードパーティから他のバージョン管理システムのサポートが提供されています。 [http://trac.edgewal.org/wiki/PluginList PluginList] と [http://trac.edgewall.org/wiki/VersioningSystemBackend VersioningSystemBackend] を参照してください。
    64 
    65 ==== Web サーバ ==== #WebServer
    66  * CGI が利用可能な Web サーバ (TracCgi を参照してください) または
    67  * [http://www.fastcgi.com/ FastCGI] が利用可能な Web サーバ (TracFastCgi を参照してください) または
    68  * [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP] 互換の Web サーバ ([http://trac.edgewall.org/wiki/TracOnWindowsIisAjp TracOnWindowsIisAjp] を参照してください) または
    69  * [http://httpd.apache.org/ Apache] と [http://code.google.com/p/modwsgi/ mod_wsgi] ([wiki:TracModWSGI] や http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac を参照してください)
    70     * mod_wsgi は非常に新しく、いくらか実験的ですが、これは Apache 1.3, 2.0 または 2.2 で動作するはずで、 mod_python を使用するよりも良いパフォーマンスが出るはずです。
    71  * [http://httpd.apache.org/ Apache] と [http://www.modpython.org/ mod_python 3.1.3 以降] (TracModPython を参照してください)
    72     * mod_python をインストールするときは、開発向けの Python と Apache が必須になります (実際にはライブラリとヘッダファイル) 。
    73 
    74 Trac を Apache と [http://www.modpython.org/ mod_python 2.7] で動かすことも可能です。([http://trac.edgewall.org/wiki/TracModPython2.7 TracModPython2.7] を参照してください) 。このガイドは 0.8.4 以降更新されていないので動作が異なるかもしれません。
    75 
    76 ==== その他の Python ユーティリティ ==== #OtherPythonUtilities
    77  * WikiRestructuredText は [http://docutils.sourceforge.net/ docutils] 0.3.9 以降が必要です。
    78  * '''シンタックスハイライト''' を行うには [http://pygments.pocoo.org Pygments] が必要です。 [http://silvercity.sourceforge.net/ SilverCity] の 0.9.7 以降や、 [http://gnu.org/software/enscript/enscript.html GNU Enscript] なども併せて使用することができます。詳細は TracSyntaxColoring を参照してください。
    79  * [http://pytz.sf.net pytz] からタイムゾーンの完全なリストを取得します。 pytz を使用しなければ Trac は内部実装された短いリストを使用します。
    80 
    81 '''Attention''': これらの依存関係は様々なバージョンで必ずしも置き換えできるとは限らないので、上記のバージョン番号に注意してください。 Trac を動かす上で問題が発生した場合は [http://trac.edgewall.org/wiki/MailingList メーリングリスト] や [http://trac.edgewall.org/wiki/IrcChannel IRC チャネル] で質問をする前にすべての依存関係を再度確認してください。
    82 
    83 これらのパッケージのドキュメンテーションを参照して、それらが最も上手にインストールできる方法を探してください。また [http://trac.edgewall.org/wiki/TracInstallPlatforms プラットフォーム特有の説明] の多くに、これらの依存関係のインストール方法が記述されています。しかしながら [http://trac.edgewall.org/wiki/TracInstallPlatforms プラットフォーム特有の説明] の情報はあなたがインストールしている Trac より古い バージョンについての説明があることを覚えておいてください (なんと Trac 0.8 に関する説明をしているページもあります)。
    84 
    85 == Tracのインストール == #InstallingTrac
    86 
    87 Trac をインストールする 1 つの方法は `setuptools` を使用することです。
    88 setuptools は subversion のリポジトリから Trac をインストールすることができます;
    89 0.11 のリリースバージョンをインストールするための例を以下に示します:
    90 {{{
    91 easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11
    92 }}}
    93 
    94 もちろん、ソースディレクトリのトップでの典型的な python セットアップもできます:
     4Trac 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
     6Since 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
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
     9
     10What 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
     16To 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
     23You also need a database system and the corresponding python bindings.
     24The database can be either SQLite, PostgreSQL or MySQL.
     25
     26==== For the SQLite database #ForSQLite
     27
     28As 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
     30However, 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
     32installers or the `tar.gz` archive for building from source:
     33{{{
     34$ tar xvfz <version>.tar.gz
     35$ cd <version>
     36$ python setup.py build_static install
     37}}}
     38 
     39This will download the latest SQLite code and build the bindings.
     40
     41SQLite 2.x is no longer supported.
     42
     43A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     44from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
     45older. See #9434 for more detail.
     46
     47See additional information in [trac:PySqlite PySqlite].
     48
     49==== For the PostgreSQL database #ForPostgreSQL
     50
     51You need to install the database and its Python bindings:
     52 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     53 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     54
     55See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     56
     57
     58==== For the MySQL database #ForMySQL
     59
     60Trac 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
     65It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database.
     66
     67=== Optional Dependencies
     68
     69==== Version Control System ====
     70
     71===== Subversion =====
     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
     74There 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
     76Note 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
     84Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
     85
     86==== Web Server ====
     87A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     88
     89Alternatively 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.
     99   
     100
     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
     118Please 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`
     123One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
     124With setuptools you can install Trac from the subversion repository;
     125
     126A few examples:
     127
     128 - install Trac 1.0:
     129   {{{
     130   easy_install Trac==1.0
     131   }}}
     132   (NOT YET ENABLED)
     133 - install latest development version 1.0dev:
     134   {{{
     135   easy_install Trac==dev
     136   }}}
     137   Note that in this case you won't have the possibility to run a localized version of Trac;
     138   either use a released version or install from source
     139
     140=== Using `pip`
     141'pip' is an easy_install replacement that is very useful to quickly install python packages.
     142To get a trac installation up and running in less than 5 minutes:
     143
     144Assuming you want to have your entire pip installation in `/opt/user/trac`
     145
     146 -
     147{{{
     148pip -E /opt/user/trac install trac psycopg2
     149}}}
     150or
     151 -
     152{{{
     153pip -E /opt/user/trac install trac mysql-python
     154}}}
     155
     156Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     157
     158pip 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
     160All 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
     162Additionally, 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
     167Of course, using the python-typical setup at the top of the source directory also works.
     168
     169You 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).
     170
    95171{{{
    96172$ python ./setup.py install
    97173}}}
    98174
    99 ''Note: このステップを実行するためには root 権限 (または root 権限と同等の権限) が必要です。''
    100 
    101 この操作で Python のソースコードがバイトコンパイルされ、 .egg ファイルかディレクトリが Python インストールの `site-packages` ディレクトリにインストールされます。
    102 .egg には htdocs や templates のような、ソースファイル以外に標準インストールの Trac が必要とするすべてのリソースが含まれています。
    103 
    104 このスクリプトは [wiki:TracStandalone tracd] スタンドアロンサーバと一緒に、 [wiki:TracEnvironment プロジェクト Environment] を作成し維持するための [wiki:TracAdmin trac-admin] コマンドラインツールをインストールします。
    105 
    106 ==== 高度なオプション ==== #AdvancedOptions
    107 
    108 Trac のインストール場所を変えるなどの高度なインストールオプションを知りたければ以下を実行してください:
     175''You'll need root permissions or equivalent for this step.''
     176
     177This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     178of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     179
     180The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server.
     181
     182If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     183{{{
     184$ python ./setup.py install
     185}}}
     186Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     187
     188=== Advanced Options ===
     189
     190To install Trac to a custom location, or find out about other advanced installation options, run:
    109191{{{
    110192easy_install --help
    111193}}}
    112194
    113 詳細な情報は [http://docs.python.org/inst/inst.html Python モジュールをインストールする] を参照してください。
    114 
    115 特にあなたは以下に興味を持つかもしれません:
     195Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     196
     197Specifically, you might be interested in:
    116198{{{
    117199easy_install --prefix=/path/to/installdir
    118200}}}
    119 Mac OS X に Trac をインストールする場合:
     201or, if installing Trac to a Mac OS X system:
    120202{{{
    121203easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    122204}}}
    123 
    124 上記の例は、 `tracd` と `trac-admin` コマンドを `/usr/local/bin` に、 Trac のライブラリと依存ファイルを `/Library/Python/2.5/site-packages` にインストールします。これらのパスは Apple での Pyhton サードパーティアプリケーションの標準ロケーションです。(訳注: つまり、上記と違うパスにインストールしたい場合のみ、オプションの指定が必要になります)
    125 
    126 == プロジェクト Environment の作成 == #CreatingaProjectEnvironment
    127 
    128 [wiki:TracEnvironment Trac Environment] は Trac が Wiki ページ、チケット、レポート、設定などの情報を保存するバックエンドストレージです。基本的に人間が読み込み可能な構成ファイルと他の様々なファイルやディレクトリで構成されます。
    129 
    130 新しい環境は [wiki:TracAdmin trac-admin] を使用して作成します:
     205Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     206
     207The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.
     208
     209
     210== Creating a Project Environment ==
     211
     212A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories.
     213
     214A new environment is created using [wiki:TracAdmin trac-admin]:
    131215{{{
    132216$ trac-admin /path/to/myproject initenv
    133217}}}
    134218
    135 [wiki:TracAdmin trac-admin] はプロジェクト名、 [wiki:TracEnvironment#SourceCodeRepository ソースコードのリポジトリ] のタイプとパス、 [wiki:TracEnvironment#DatabaseConnectionStrings データベース接続文字列] など、 Environment を作成するのに必要な情報の入力を促します。これらのオプションを指定せず、空白を入力するとデフォルト値が使用されます。 SQLite がインストールされている場合、データベース接続文字列はいつでもデフォルト値で動作します。バージョン管理システムのリポジトリへのパスを指定しない場合、バージョン管理に関するすべての機能が無効化されますが、基本システムが動いていればいつでもバージョン管理に関する機能を追加することができます。
    136 
    137 また、 ここで指定した値は [wiki:TracIni] 設定ファイルを直接編集することで後から変更できることに留意してください。
    138 
    139 ''Note: Web サーバのユーザアカウントは Environment のディレクトリと、その中のすべてのファイルに対する書き込み権限が必要です。 Linux では、 Web サーバが apache というユーザ、 apache というグループで起動している場合は以下のように入力してください。:''
    140 
    141   chown -R apache.apache /path/to/myproject
    142 
    143 '''Warning: インストールされたファイルの中から trac.cgi を探しても見つかりません。現在のドキュメントは不完全な状態です; trac-admin の 'deploy' コマンドを使う必要があります。詳細は http://trac.edgewall.org/ticket/7312 や http://trac.edgewall.org/ticket/6827 を参照してください。'''
    144 
    145 == スタンドアロンサーバの起動 == #RunningtheStandaloneServer
    146 
    147 Trac 環境を作成した後に、スタンドアロンサーバ [wiki:TracStandalone tracd] を実行することで簡単に 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
     221Using the default database connection string in particular will always work as long as you have SQLite installed.
     222For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     223
     224Since 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
     226Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     227
     228Finally, 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:
     229{{{
     230# chown -R apache.apache /path/to/myproject
     231}}}
     232
     233{{{#!div class=important
     234'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     235}}}
     236
     237
     238== Deploying Trac
     239
     240=== Running the Standalone Server ===
     241
     242After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    148243{{{
    149244$ tracd --port 8000 /path/to/myproject
    150245}}}
    151246
    152 ブラウザを起動して、 `http://localhost:8000/` にアクセスしてください。 tracd が認識しているすべての Environment の簡単な一覧が表示されます。作成した Environment へのリンクにアクセスすることで Trac が動作中であることを確認できます。 Trac でプロジェクトをひとつだけ管理したい場合、以下のように起動することで、スタンドアロンサーバは Environment 一覧の表示をスキップして、直接 Environment を表示します:
     247Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this:
    153248{{{
    154249$ tracd -s --port 8000 /path/to/myproject
    155250}}}
    156251
    157 
    158 == Web サーバ上での Trac の起動 == #RunningTraconaWebServer
    159 
    160 Trac に "真の" Web サーバから接続するには 3 つの方法があります: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModPython mod_python] です。まともな性能を出すには FastCGI か mod_python のどちらかを使用することが推奨されます。
    161 
    162 また、新しいコードを実行することを恐れていないのであれば [wiki:TracModWSGI mod_wsgi] を実行してみることもできます。 mod_wsgi は mod_python 以上の性能を提供するはずですが、 mod_python に比べ充分テストされたわけではありません。
    163 
    164 Trac では [http://trac.edgewall.org/wiki/TracOnWindowsIisAjp AJP] も使用できます。これを使うと IIS とも接続することができます。
    165 
    166 ==== プラグインキャッシュの設定 ==== #SettingupthePluginCache
    167 
    168 Python プラグインの中にはキャッシュディレクトリを必要とするものがあります。デフォルトではキャッシュディレクトリは、現在のユーザのホームディレクトリに置かれます。 Trac を Web サーバで動作させている場合、ホームディレクトリを持たない専用ユーザであることが多く (強く推奨します)、プラグインの起動が妨げられることがあります。キャッシュディレクトリの場所を変更するには、環境変数 PYTHON_EGG_CACHE を設定してください。設定方法の詳細は使用しているサーバのドキュメントから参照してください。
    169 
    170 == 認証の構成 == #ConfiguringAuthentication
    171 
    172 認証のためのユーザアカウントを追加、削除、構成する方法は Trac を起動する方法により異なります。基本的な手順は TracCgi ページの [wiki:TracCgi#AddingAuthentication "認証を追加する"] セクションで説明されていますが、各フロントエンドのための認証をセットアップする方法は、以下のいずれかを参照してください:
    173 
    174  * TracStandalone スタンドアロンサーバ `tracd` を使用する場合
    175  * TracCgi CGI か FastCGI を使用する場合
    176  * TracModPython mod_python を使用する場合
    177 
    178 == SVN のチェンジセットを Trac のチケットに自動リンクする方法 == #AutomaticreferencetotheSVNchangesetsinTractickets
    179 
    180 ファイルをリポジトリにコミットした時に、チェンジセットへのリンクをチケットのコメントに自動で追加するように SVN を設定することができます。コミットメッセージには以下に示すいずれかの書式が含まれていなければなりません:
    181  * '''Refs !#123''' - このチェンジセットへのリンクをチケット !#123 に追加します
    182  * '''Fixes !#123''' - このチェンジセットへのリンクをチケット !#123 に追加し、チケットを ''fixed'' でクローズします。
    183 
    184 SVN リポジトリの ''post-commit'' hook を編集し、 Trac 配布物に含まれる ''trac-post-commit-hook'' が実行されるようにしてください。
    185 
    186 ''post-commit'' hook を編集するときは、まず SVN リポジトリ内の hooks フォルダに移動し、 ''post-commit'' 用のテンプレートファイルを rename してファイルを作成します:
    187 
    188 {{{
    189 $ cd /path/to/svn/repository/hooks
    190 $ mv post-commit.tmpl post-commit
    191 $ chmod 755 post-commit
    192 }}}
    193 
    194 続いて、ファイルをテキストエディタで開き、以下の行を追加します。パスは編集中の SVN リポジトリに接続している Trac environment のパス、および ''trac-post-commit-hook'' スクリプトのパスで置き換えてください:
    195 
    196 {{{
    197 REPOS="$1"
    198 REV="$2"
    199 TRAC_ENV="/path/to/your/trac/project"
    200 
    201 /usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV"
    202 }}}
    203 
    204 もちろん ''trac-post-commit-hook'' は上記のパスに存在し、 SVN を実行しているユーザの権限で実行できる必要があります。このスクリプトは Trac 配布物中では contrib フォルダに配置されています。最新のバージョンは [http://trac.edgewall.org/browser/trunk/contrib/trac-post-commit-hook trunk/contrib/trac-post-commit-hook] からダウンロードすることができます。
    205 
    206 
    207 == プラットフォーム固有のインストール方法 == #Platform-specificsinstallations
    208 
    209  * [http://trac.edgewall.org/wiki/TracInstallPlatforms TracInstallPlatforms] を参照してください。
    210  
    211 
    212 == Tracを使用する == #UsingTrac
    213 
    214 一度 Trac サイトを稼働させれば、 Subversion のリポジトリをブラウズする、チケットを作成する、タイムラインを見るなどが可能になるはずです。
    215 
    216 anonymous (ログインしていない) でアクセスするユーザは、デフォルトでほとんどの機能を使用することができますが、すべての機能を使用できるわけではないことに留意してください。すべての機能を使用するためには認証を構成して、認証されたユーザに対し [wiki:TracPermissions アクセス許可] を与える必要があるでしょう。
     252=== Running Trac on a Web Server ===
     253
     254Trac 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
     260Trac 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
     264In 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
     266There 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:
     267{{{
     268mkdir -p /usr/share/trac/projects/my-project
     269trac-admin /usr/share/trac/projects/my-project initenv
     270trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     271mv /tmp/deploy/* /usr/share/trac
     272}}}
     273
     274
     275==== Mapping Static Resources ====
     276
     277Out 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
     279Web 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
     281There 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
     283Note 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
     286The 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
     293Assuming the deployment has been done this way:
     294{{{
     295$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
     296}}}
     297
     298Add 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{{{
     300Alias /trac/chrome/common /path/to/trac/htdocs/common
     301Alias /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
     309If 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
     316Note 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
     318Similarly, 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{{{
     320Alias /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
     328Alternatively 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]
     331htdocs_location = http://static.example.org/trac-common/
     332}}}
     333Note 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
     335Of 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
     343Some 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
     347Trac 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
     349The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     350
     351Please 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
     357Grant admin rights to user admin:
     358{{{
     359$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     360}}}
     361This 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
     367You 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
     371This 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.
     372{{{
     373tracopt.ticket.commit_updater.* = enabled
     374}}}
     375For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     376
     377=== Using Trac ===
     378
     379Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc.
     380
     381Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
    217382
    218383'' Enjoy! ''
    219384
    220 [http://trac.edgewall.org/wiki/TracTeam The Trac Team]
     385[trac:TracTeam The Trac Team]
    221386
    222387----
    223 See also:  [http://trac.edgewall.org/wiki/TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
     388See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions