Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
08/27/15 23:20:06 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    1 = Trac インストールガイド =
     1= Trac Installation Guide for 1.0
     2
    23[[TracGuideToc]]
    34
    4 Trac は軽量なプロジェクト管理ツールで、 Web ベースのアプリケーションとして実装されています。 Trac は Python で記述されており、データベースが必要です。 ([http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL] が使用可能です)。 HTML レンダリングには [http://www.clearsilver.net/ Clearsilver] テンプレートシステムを使用します。
    5 
    6 以下に示すのは、 Trac のインストールと設定要件に関する一般的な説明です。 Trac を特定のシステムにインストールするための説明は Trac のメインサイトの [http://trac.edgewall.org/wiki/TracInstallPlatforms TracInstallPlatforms] に掲載されています。インストールに必要なタスクをよく理解するためにこれらの一般的な説明を最初に必ず読んでください。
    7 
    8 == インストール要件 ==
    9 
    10 ソフトウェア要件:
    11 
    12  * [http://www.python.org/ Python], バージョン 2.3 以上。
    13    * RPM をベースとしたシステムでは `python-devel` と `python-xml` パッケージも必要かもしれません。
    14    * もし Windows 上で Trac を Subversion とともに使用するならば、 Python 2.4 用にプリコンパイルされた Subversion bindings がないので、 Python 2.3 が必要になるでしょう。
    15     * 2006-09-20: この記述はもはや正しくないかもしれません。 http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 を参照して下さい。 Subversion 1.4.0 用の python 2.4 の バイナリの bindings が利用可能となっています。
    16  * [http://www.clearsilver.net/ ClearSilver], バージョン 0.9.3 以上。
    17    * python-bindings (`./configure --with-python=/usr/bin/python`)
    18  * データベースと使用するデータベースに適切な Python のドライバが必要です。
    19    データベースとして SQLite, PostgreSQL, MySQL ''(実験的)'' が使用できます。
    20 
    21 === SQLite 利用 ===
    22 
    23  * [http://www.sqlite.org/ SQLite], バージョン 2.8.x か 3.x(推奨)
    24  * [http://pysqlite.org/ PySQLite], バージョン 1.x (SQLite 2.x 用) またはバージョン 2.x (SQLite 3.x 用)。詳細は[http://trac.edgewall.org/wiki/PySqlite PySqlite] 参照。
    25 
    26 ''Note: Trac のバージョン 0.9 以前では PySQLite 2.x は '''動きません'''。''
    27 
    28 ''Note: リポジトリの 'contrib' セクションにある 'trac-post-commit-hook.py' スクリプトを使用するつもりならば、PySQLite 2.x は Trac 0.9+/SQLite 3.x が必要です。
    29 
    30 ''Note: Mac OS X のユーザは気を付けて下さい; Apple 社が供給している SQLite は AFP や SMP といったネットワークファイルシステムにおけるファイルのロックを実現するためのコードが含まれています。これは現在の主流ではありませんので、ソースコードから自分で SQLite をビルドする場合、このようなファイルシステムでは正しく動かないでしょう。- たいていの場合、 "{{{database is locked}}}" というエラーがでるでしょう。 アップル社のコードのバージョン 3.3.6 で利用可能な [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ パッチ] があります。それ以外では、アップル社が供給しているバージョン (現在 3.1.3) を使用するのがたぶん最良でしょう。
    31 
    32 === PostgreSQL 利用 ===
    33 
    34  * [http://www.postgresql.org/ PostgreSQL]
    35  * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
    36 
    37 ''Note: PostgreSQL に対応しているのは Trac バージョン 0.9 以降です。''
    38 
    39 === MySQL 利用 ===
    40 
    41 '''注意''': MySQL の対応は現在実験段階です。動くかもしれませんが、まだ十分にテストはされていません。
    42 
    43  * [http://mysql.com/ MySQL], version 4.1 or later
    44  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
    45 
    46 ''Note: MySQL に対応しているのは Trac バージョン 0.10 以降です。''
    47 
    48 === オプション要件 ===
    49 
    50 ==== バージョン管理システム ====
    51  * [http://subversion.tigris.org/ Subversion], バージョン 1.0 以降(1.2.3 もしくは 1.3.1以降推奨) と 対応する [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]。トラブルシューティングについては、 [http://projects.edgewall.com/trac/wiki/TracSubversion TracSubversion] を参照して下さい。
    52    * Trac は Subversion の配布物の中の [http://www.swig.org/ SWIG] bindings を使用します。[http://pysvn.tigris.org/ PySVN]''' ではありません'''。(ときどき標準の SWIG bindings と混同します)
    53    * もし Subversion が SWIG bindings なしでインストールされていた場合、 Subversion をre-`configure` して `make swig-py`, `make install-swig-py` を実行する必要があります。
    54  * サードパーティが提供しているほかのバージョン管理システムに対応しています。 [http://projects.edgewall.com/trac/wiki/PluginList PluginList] と[http://projects.edgewall.com/trac/wiki/VersioningSystemBackend VersioningSystemBackend] を参照して下さい。
    55 
    56 ==== Web サーバ ====
    57  * CGI を利用可能な Web サーバ (see TracCgi) または
    58  * [http://www.fastcgi.com/ FastCGI] を利用可能な Web サーバ(see TracFastCgi) または
    59  * [http://httpd.apache.org/ Apache] と [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    60     * mod_python の開発バージョンをインストールするとき、 Python と Apache が必要です。 (実際のライブラリとヘッダファイル)
    61 
    62 Apache 1.3 で実行するには、 Trac 0.8.4 と[http://www.modpython.org/ mod_python 2.7] を使用することで可能となります。([http://trac.edgewall.org/wiki/TracModPython2.7 TracModPython2.7] 参照) Trac 0.9 ではテストしていないので、動くかどうかは分かりません。
    63 
    64 ==== その他の Python のユーティリティ ====
    65  * プラグインを使用する場合 [http://peak.telecommunity.com/DevCenter/setuptools setuptools], バージョン 0.6 以上。 (see TracPlugins)
    66  * WikiRestructuredText を使用する場合 [http://docutils.sourceforge.net/ docutils], バージョン 0.3.9 以上
    67  * [wiki:TracSyntaxColoring シンタックス ハイライト] を使用する場合 [http://silvercity.sourceforge.net/ SilverCity] または [http://www.gnu.org/software/enscript/enscript.html Enscript] もしくは両方。
    68     * !SilverCity 0.9.6 には [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 バグ] があり、 Trac で Python のシンタックスハイライトを壊してしまいます。更新バージョンが利用可能になるまで、バージョン 0.9.5 を使用することを推奨します。
    69 
    70 ''注意''': これらのソフトウェアの依存するパッケージに利用可能なバージョンがいろいろありますが、かならずしも互換性あるとは限りません。上記のバージョン番号に注意してください。もし Trac が動かないようだったら、すべての依存関係をもう一度確認してください。確認したうえで、 [http://trac.edgewall.org/wiki/MailingList メーリングリスト] や [http://trac.edgewall.org/wiki/IrcChannel IRCチャンネル] をたずねてみてください。
    71 
    72 これらのパッケージの最もよいインストール方法を理解するためにパッケージ付属のドキュメントを読んでください。加えて、 [http://trac.edgewall.org/wiki/TracInstallPlatforms プラットフォーム特有の説明] にも、インストール時の依存関係が記述されています。ただしそれもインストールしようとしている Trac のバージョンより古いバージョンにおける情報かもしれないということを覚えておいて下さい。(特に、
    73 いくつかのページは Trac 0.8 の説明になっています。)
    74 
    75 == Trac のインストール ==
    76 
    77 多くの Python プログラムと同様、ソースディレクトリの一番上で次のコマンドを実行することで、 Trac の Python パッケージをインストールできます:
    78 {{{
     5Trac 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.
     6
     7Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want 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.
     8
     9If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
     10
     11What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     12
     13[[PageOutline(2-3,Installation Steps,inline)]]
     14
     15== Dependencies
     16
     17=== Mandatory Dependencies
     18
     19To install Trac, the following software packages must be installed:
     20
     21 * [http://www.python.org/ Python], version >= 2.5 and < 3.0
     22   (note that we dropped the support for Python 2.4 in this release)
     23 * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
     24 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     25
     26You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     27
     28==== For the SQLite database #ForSQLite
     29
     30As 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.
     31
     32Optionally, you may install a newer version of [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     33
     34==== For the PostgreSQL database #ForPostgreSQL
     35
     36You need to install the database and its Python bindings:
     37 * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
     38 * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     39
     40See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     41
     42==== For the MySQL database #ForMySQL
     43
     44Trac works well with MySQL, provided you follow the guidelines:
     45
     46 * [http://mysql.com/ MySQL] or [http://mariadb.org/ MariaDB], version 5.0 or later
     47 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     48
     49Given the caveats and known issues surrounding MySQL, read the [trac:MySqlDb] page before creating the database.
     50
     51=== Optional Dependencies
     52
     53==== Version Control System
     54
     55===== Subversion
     56 * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''corresponding''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     57
     58There 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. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.)
     59
     60Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.
     61
     62'''Note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     63
     64===== Git
     65 * [http://git-scm.com/ Git] 1.5.6 or later.
     66
     67More information is available on the [trac:TracGit] page.
     68
     69===== Others
     70
     71Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
     72
     73==== Web Server
     74
     75A web server is optional because Trac has a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
     76
     77Alternatively you can configure Trac to run in any of the following environments:
     78 * [http://httpd.apache.org/ Apache] with
     79   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     80     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     81   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
     82 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     83 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     84   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     85 * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
     86 * a CGI-capable web server (see TracCgi), but //usage of Trac as a cgi script
     87   is highly discouraged//, better use one of the previous options.
     88   
     89==== Other Python Packages
     90
     91 * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
     92   needed for localization support
     93 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     94   for WikiRestructuredText.
     95 * [http://pygments.org Pygments] for
     96   [TracSyntaxColoring syntax highlighting].
     97   [http://silvercity.sourceforge.net/ SilverCity] and/or
     98   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     99   but are deprecated and you really should be using Pygments.
     100 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     101   otherwise Trac will fall back on a shorter list from
     102   an internal time zone implementation.
     103
     104{{{#!div style="border: 1pt dotted; margin: 1em"
     105**Attention**: The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. 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].
     106}}}
     107
     108Please 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.
     109
     110== Installing Trac
     111
     112The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac.
     113
     114=== Using `easy_install`
     115
     116Trac can be installed from [https://pypi.python.org/pypi/Trac PyPI] or the Subversion repository using [pypi:setuptools setuptools].
     117
     118A few command-line examples:
     119
     120 - Install Trac 1.0:
     121 {{{#!sh
     122$ easy_install Trac==1.0
     123}}}
     124 - Install latest development version:
     125 {{{#!sh
     126$ easy_install Trac==dev
     127}}}
     128   Note that in this case you won't have the possibility to run a localized version of Trac;
     129   either use a released version or install from source.
     130
     131More information can be found on the [trac:setuptools] page.
     132
     133{{{#!div style="border: 1pt dotted; margin: 1em"
     134**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server].
     135}}}
     136
     137=== Using `pip`
     138
     139'pip' is an easy_install replacement that is very useful to quickly install Python packages.
     140To get a Trac installation up and running in less than 5 minutes:
     141
     142Assuming you want to have your entire pip installation in `/opt/user/trac`:
     143
     144 -
     145 {{{#!sh
     146$ pip install trac psycopg2
     147}}}
     148or:
     149 -
     150 {{{#!sh
     151$ pip install trac mysql-python
     152}}}
     153
     154Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
     155
     156pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`.
     157
     158All 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).
     159
     160Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
     161
     162=== From source
     163
     164Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
     165
     166{{{#!sh
    79167$ python ./setup.py install
    80168}}}
    81169
    82 ''Note: このステップをおこなうには root 権限、またはそれと同等の権限が必要です。''
    83 
    84 この手順は、 Python ソースコードをバイトコンパイルして、 Python の `site-packages` ディレクトリにインストールします。
    85 また、ディレクトリ `cgi-bin`, `template`, `htdocs`, `wiki-default`, `wiki-macros` 配下のすべてのファイルを `$prefix/share/trac/` ディレクトリにコピーします。 `conf` と `plugins` ディレクトリは `$prefix/share/trac` 配下に新規に作成されます (''[http://trac.edgewall.org/milestone/0.10 milestone:0.10] 以降'')。
    86 
    87 さらに、このスクリプトでは  [wiki:TracEnvironment Trac environment] を作成したりメンテナンスするためのコマンドラインツールである [wiki:TracAdmin trac-admin] や、スタンドアロンで動作するサーバ [wiki:TracStandalone tracd] をインストールします。
    88 
    89 === 上級オプション ===
    90 
    91 Trac を上記以外の場所にインストールしたい場合や、その他の高度なインストールオプションを見たい場合は次のコマンドを実行してください:
    92 {{{
    93 $ python ./setup.py install --help
    94 }}}
    95 
    96 詳細は [http://docs.python.org/inst/inst.html Installing Python Modules] を参照。
    97 
    98 単純にインストールする場所を変えたいのであれば、以下の通りです:
    99 {{{
    100 $ python ./setup.py install --prefix=/path/to/installdir
    101 }}}
    102 
    103 == プロジェクト環境の作成 ==
    104 
    105 [wiki:TracEnvironment Trac environment] は Trac が Wiki ページ、チケット、レポート、設定などのような情報を保存するバックエンドストレージです。 [wiki:TracEnvironment Trac environment] は基本的に、人間が読むことができる設定ファイル、その他いろいろなファイルとディレクトリを含んだディレクトリです。
    106 
    107 [wiki:TracAdmin trac-admin] を使用して、新しい Trac environment を作成します。:
    108 {{{
     170You will need root permissions or equivalent for this step.
     171
     172This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     173of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
     174
     175If 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):
     176{{{#!sh
     177$ python ./setup.py install
     178}}}
     179
     180Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     181
     182=== Using installer
     183
     184On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
     185
     186=== Using package manager
     187
     188Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release.
     189
     190=== Advanced `easy_install` Options
     191
     192To install Trac to a custom location, or find out about other advanced installation options, run:
     193{{{#!sh
     194$ easy_install --help
     195}}}
     196
     197Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
     198
     199Specifically, you might be interested in:
     200{{{#!sh
     201$ easy_install --prefix=/path/to/installdir
     202}}}
     203
     204or, if installing Trac on a Mac OS X system:
     205{{{#!sh
     206$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     207}}}
     208
     209'''Note''': 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.5/site-packages }}} by default.
     210
     211The 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.
     212
     213== Creating a Project Environment
     214
     215A [TracEnvironment Trac environment] is the backend 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 other files and directories.
     216
     217A new environment is created using [TracAdmin trac-admin]:
     218{{{#!sh
    109219$ trac-admin /path/to/myproject initenv
    110220}}}
    111221
    112 [wiki:TracAdmin trac-admin] がプロジェクト環境を作成するのに必要な情報を聞いてきます。たとえば、プロジェクトの名前や、[wiki:TracEnvironment#SourceCodeRepository ソースコードリポジトリ] の種類とパス、 [wiki:TracEnvironment#データベースに接続するための文字列 データベースに接続するための文字列] などです。もしこれらのオプションで設定を何にすればいいのか分からなければ、デフォルト値を使用するために空白にしておいてください。特にデータベースに接続するための文字列は SQLite をインストールしている限り、動くでしょう。ソースコードリポジトリへのパスを空白にしておくとバージョン管理に関する機能が無効になりますが、システムが動いてさえいれば、後からいつでも追加することができます。
    113 
    114 また、ここで指定した値は後で [wiki:TracIni 設定ファイル] を編集することによって変更できます。
    115 
    116 ''Note: Web サーバの起動ユーザには、この environment ディレクトリ、
    117 およびその配下のすべてのファイルに対する書き込みパーミッションが必要です。''
    118 
    119 
    120 == スタンドアロンサーバを起動する ==
    121 
    122 Trac environment を作成した後, スタンドアロンサーバの [wiki:TracStandalone tracd] を起動することによって簡単に Web インタフェースを使ってみることができます。
    123 {{{
     222[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.
     223
     224Using the default database connection string in particular will always work as long as you have SQLite installed.
     225For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     226
     227Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
     228
     229Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     230
     231{{{#!div style="border: 1pt dotted; margin: 1em"
     232**Filesystem Warning:** When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux, or HFS+ on OSX), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
     233}}}
     234
     235Finally, 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:
     236{{{#!sh
     237$ chown -R apache.apache /path/to/myproject
     238}}}
     239
     240The actual username and groupname of the Apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use).
     241
     242{{{#!div class=important
     243'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.
     244}}}
     245
     246== Deploying Trac
     247
     248=== Running the Standalone Server
     249
     250After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
     251{{{#!sh
    124252$ tracd --port 8000 /path/to/myproject
    125253}}}
    126254
    127 そして、ブラウザを起動して、 `http://localhost:8000/` にアクセスしてみてください。 tracd が認識しているすべての環境が簡単にリストされます。作成した環境へのリンクをクリックし、実際の Trac を見るべきです。
    128 
    129 
    130 == Web サーバで Trac を起動する ==
    131 
    132 Tracは“"本当の" Web サーバに接続するための 3 つのオプションを提供しています: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] と [wiki:TracModPython mod_python] です。まともなパフォーマンスを引き出すために、 FastCGI か mod_python を使用することをおすすめします。
    133 
    134 == 認証の設定 ==
    135 
    136 ユーザアカウントの追加・削除・設定はどのような方法で Trac を動かしているかによります。基本的な手順は TracCgi ページの [wiki:TracCgi#認証を追加する 認証を追加する] セクションに書かれています。使用しているフロントエンドでの認証の設定方法を学ぶには、以下のページのどれかを参照してください:
    137 
    138  * TracStandalone スタンドアロンサーバ `tracd` を使用している場合
    139  * TracCgi CGI または FastCGI を使用している場合
    140  * TracModPython mod_python を使用している場合
    141 
    142 == Trac を使う ==
    143 
    144 一度、 Trac のサイトを構築して起動したら、 Subversion のリポジトリをブラウズしたり、チケットを登録したり、タイムラインを見たりすることができます。
    145 
    146 デフォルトの設定では、 anonymous ユーザ (ログインしていないユーザ) でも大半の機能を使用できますが、全てではありません。認証を設定し、認証済みのユーザがすべての機能を利用できるように [wiki:TracPermissions 権限] を追加するのを忘れないで下さい。
    147 
    148 ''それでは楽しんで!''
    149 
    150 [http://trac.edgewall.org/wiki/TracTeam The Trac Team]
     255Then, 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:
     256{{{#!sh
     257$ tracd -s --port 8000 /path/to/myproject
     258}}}
     259
     260{{{#!div style="border: 1pt dotted; margin: 1em"
     261**Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. The environment variable can be set system-wide, or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
     262
     263To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
     264{{{#!sh
     265export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
     266}}}
     267
     268Alternatively, the variable can be set in the shell before executing `tracd`:
     269{{{#!sh
     270$ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
     271}}}
     272}}}
     273
     274=== Running Trac on a Web Server
     275
     276Trac provides various options for connecting to a "real" web server:
     277 - [TracFastCgi FastCGI]
     278 - [wiki:TracModWSGI mod_wsgi]
     279 - [TracModPython mod_python]
     280 - //[TracCgi CGI]: should not be used, as it degrades performance//
     281
     282Trac 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.
     283
     284==== Generating the Trac cgi-bin directory #cgi-bin
     285
     286In 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 [TracAdmin trac-admin].
     287
     288There is, however, a bit of a chicken-and-egg problem. The [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:
     289{{{#!sh
     290$ mkdir -p /usr/share/trac/projects/my-project
     291$ trac-admin /usr/share/trac/projects/my-project initenv
     292$ trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     293$ mv /tmp/deploy/* /usr/share/trac
     294}}}
     295
     296Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     297
     298==== Mapping Static Resources
     299
     300Out 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''' as it causes abysmal performance.
     301
     302Web 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.
     303
     304There 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.
     305
     306Note 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:
     307[[TracAdminHelp(deploy)]]
     308
     309The target `<directory>` will then contain an `htdocs` directory with:
     310 - `site/` - a copy of the environment's directory `htdocs/`
     311 - `common/` - the static resources of Trac itself
     312 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment
     313
     314===== Example: Apache and `ScriptAlias` #ScriptAlias-example
     315
     316Assuming the deployment has been done this way:
     317{{{#!sh
     318$ trac-admin /var/trac/env deploy /path/to/shared/trac
     319}}}
     320
     321Add 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:
     322{{{#!apache
     323Alias /trac/chrome/common /path/to/trac/htdocs/common
     324Alias /trac/chrome/site /path/to/trac/htdocs/site
     325
     326<Directory "/path/to/www/trac/htdocs">
     327  Order allow,deny
     328  Allow from all
     329</Directory>
     330}}}
     331
     332If using mod_python, you might want to add this too, otherwise the alias will be ignored:
     333{{{#!apache
     334<Location "/trac/chrome/common/">
     335  SetHandler None
     336</Location>
     337}}}
     338
     339Note 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.
     340
     341Similarly, 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):
     342{{{#!apache
     343Alias /trac/chrome/site /path/to/projectenv/htdocs
     344
     345<Directory "/path/to/projectenv/htdocs">
     346  Order allow,deny
     347  Allow from all
     348</Directory>
     349}}}
     350
     351Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     352{{{#!ini
     353[trac]
     354htdocs_location = http://static.example.org/trac-common/
     355}}}
     356
     357Note 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].
     358
     359Of 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:
     360{{{#!sh
     361$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
     362}}}
     363
     364==== Setting up the Plugin Cache
     365
     366Some 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.
     367
     368== Configuring Authentication
     369
     370Trac 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.
     371
     372The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
     373
     374Please refer to one of the following sections:
     375 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.
     376 * [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`.
     377 * TracFastCgi if you are using another web server with FCGI support, such as Cherokee, Lighttpd, !LiteSpeed, nginx.
     378
     379The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
     380
     381== Granting admin rights to the admin user
     382
     383Grant admin rights to user admin:
     384{{{#!sh
     385$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
     386}}}
     387
     388This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
     389
     390== Finishing the install
     391
     392=== Enable version control components
     393
     394Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
     395
     396The version control systems are enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel:
     397
     398{{{#!ini
     399[components]
     400tracopt.versioncontrol.svn.* = enabled
     401}}}
     402
     403{{{#!ini
     404[components]
     405tracopt.versioncontrol.git.* = enabled
     406}}}
     407
     408After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
     409
     410=== Using Trac
     411
     412Once 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.
     413
     414Keep 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 [TracPermissions permissions] to authenticated users to see the full set of features.
     415
     416'' Enjoy! ''
     417
     418[trac:TracTeam The Trac Team]
    151419
    152420----
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions
     421See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions