Changes between Version 1 and Version 2 of TracInstall
- Timestamp:
- Sep 2, 2019, 4:56:56 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v1 v2 1 = Trac Installation Guide for 1. 0 =1 = Trac Installation Guide for 1.3 2 2 [[TracGuideToc]] 3 3 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 Installing Trac] セクションのローカライゼーションのサポートの手順を参照してください。 Babel がない場合、通常通り、デフォルトの英語バージョンのみ使用することができます。 7 8 新しい言語での翻訳の作成や、すでにある言語での翻訳のエンハンスをコントリビュートした場合は [[trac:TracL10N]] を見てみてください。 (訳注: 日本語の翻訳はすでにコントリビュートされています) 9 10 Trac のインストールとセットアップに対する一般的な手順と必要な条件を以下に示します。 Trac を特定のシステムにインストールする手順は Trac Project サイトの [trac:TracInstallPlatforms TracInstallPlatforms] にありますが、 '''まず最初に以下の一般的な手順を読み通して''' タスクの関係を確実に理解してください。 11 12 [[PageOutline(2-3,インストール手順,inline)]] 13 14 == 依存関係 == #Dependencies 15 === 必須の依存関係 === #MandatoryDependencies 16 Trac をインストールするためには以下のソフトウェアパッケージがインストールされていなければなりません: 17 18 * [http://www.python.org/ Python], 2.5 以上 3.0 未満 19 (Python 2.4 のサポートは、このリリース(訳注: 1.0)で打ち切られました) 20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], 0.6 以上, [http://pypi.python.org/pypi/distribute ディストリビュート] を使用してもかまいません 21 * [http://genshi.edgewall.org/wiki/Download Genshi], 0.6 以上(リリースはされていませんが 0.7dev でも正しく動作します) 22 23 また、データベースと、それに対応する Python のバインディングが必要です。 24 データベースは SQLite, PostgreSQL, MySQL のいずれかが使用できます。 25 26 ==== SQLite の場合 ==== #ForSQLite 27 28 Python 2.5 、 2.6 、 2.7 には、SQLite データベースのライブラリがPython の標準ディストリビューションに( `sqlite3` モジュールとして)同梱されています。 29 30 もちろん、最新の [[trac:Pysqlite]] をダウンロードすることも可能です。 31 [http://code.google.com/p/pysqlite/downloads/list google code] から Windows インストーラやソースからビルドするための 32 tar.gz アーカイブがダウンロードできます。 33 {{{ 34 $ tar xvfz <version>.tar.gz 35 $ cd <version> 36 $ python setup.py build_static install 37 }}} 38 39 上記の手順で最新の SQLite コードがダウンロードされバインディングがビルドされます。 40 41 SQLite 2.x のサポートは終了しました。 42 43 既知のバグとして、 PySqlite バージョン 2.5.2-4 では、 Trac のデータベースを 44 0.11.x から 0.12. にアップグレードすることができません。 2.5.5 以降か 2.5.1 と 45 それ以前のバージョンを使用して下さい。詳細については、 [trac:#9434 本家チケット 9434] を参照して下さい。 46 47 [trac:PySqlite PySqlite] にさらに情報があります。 48 49 ==== PostgreSQL の場合 #ForPostgreSQL 50 51 下記いずれかの データベースと、データベースに対応した Python バインディングをインストールする必要があります: 52 * [http://www.postgresql.org/ PostgreSQL], バージョン 8.0 以降 53 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 54 55 詳しくは [trac:DatabaseBackend#Postgresql DatabaseBackend] を参照してください。 56 57 58 ==== MySQL の場合 ==== #ForMySQL 59 60 Trac は以下のガイドラインで、 MySQL でも良好に動作するようになりました。 61 62 * [http://mysql.com/ MySQL], 5.0 以降 63 * [http://sf.net/projects/mysql-python MySQLdb], 1.2.2 以降 64 65 '''非常に''' 重要なことが記載されているので、データベースを作成する前に、[trac:MySqlDb] のページを注意深く読んで下さい。 66 67 === 任意の依存関係 === #OptionalDependencies 68 69 ==== バージョン管理システム ==== #VersionControlSystem 70 71 ===== Subversion ===== 72 * [http://subversion.apache.org/ Subversion] 1.5.x または 1.6.x と '''''対応する''''' Python バインディング。1.0 から 1.2.4 や 1.3.2 、 1.4.2 などの古いバージョンも今のところ動作します。トラブルシューティングの情報が [trac:TracSubversion#Troubleshooting TracSubversion] のページに記載されていますので、確認してください 73 74 様々なプラットフォーム向けに [http://subversion.apache.org/packages.html SWIG バインディング] が用意されています。(このリストから Windows パッケージ用のコンパイル済みの SWIG バインディングを探してください。TracSubversion には [http://alagazam.net Algazam] がよいです。私も python 2.6 の基、使用しています。) 75 76 Note: Trac は [http://pysvn.tigris.org/ PySVN] のような新しい `ctype` 形式のバインディングでは '''動作しません'''。 77 78 79 '''重要な Note:''' Subversion を使用するなら Trac を '''同じマシン''' にインストールする必要があります。リモートリポジトリは現在 [trac:#493 サポートされていません]。 80 81 82 ===== その他のバージョン管理システム ===== #Others 83 84 Subversion 以外のバージョン管理システムのサポートはサードパーティから提供されます。 [trac:PluginList] や [trac:VersionControlSystem] を参照して下さい。 85 86 ==== Web サーバ ==== #WebServer 87 Trac にはサーバ機能が組み込まれているので、 Web サーバは必須ではありません。このページに下にある [#RunningtheStandaloneServer スタンドアロンサーバの起動] セクションを参照してください。 88 89 Trac は下記の環境において動作します。 90 * [http://httpd.apache.org/ Apache] との組み合わせで 91 - [http://code.google.com/p/modwsgi/ mod_wsgi], [wiki:TracModWSGI] と 92 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac を参照 93 - [http://modpython.org/ mod_python 3.3.1], 非奨励 (TracModPython 参照) 94 * [http://www.fastcgi.com/ FastCGI] 対応 Web サーバ (TracFastCgi 参照) 95 * [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP] 対応 Web 96 サーバ ([trac:TracOnWindowsIisAjp TracOnWindowsIisAjp] 参照) 97 * CGI 対応 Web サーバ (TracCgi 参照)。’’’Trac を CGI スクリプトとして使用することは 98 全く推奨されていませんので’’’ 、上記に挙げた方法を選択して下さい 99 100 101 ==== その他の Python パッケージ ==== #OtherPythonPackages 102 103 * [http://babel.edgewall.org Babel], 0.9.5 以上 104 ローカライズの機能を使用する場合は必要(リリースはされていませんが 1.0dev でも正しく動作します) 105 * [http://docutils.sourceforge.net/ docutils], 0.3.9 以上 106 WikiRestructuredText の機能を使用する場合は必要 107 * [http://pygments.pocoo.org Pygments] 108 [wiki:TracSyntaxColoring シンタックスハイライティング] の機能を使用する場合は必要 109 [http://silvercity.sourceforge.net/ SilverCity] や 110 [http://gnu.org/software/enscript/enscript.html Enscript] も、今のところ使用できますが、 111 サポートを打ち切る予定なので、 Pygments を使用してください 112 * [http://pytz.sf.net pytz] , タイムゾーンの完全なリストを取得する場合に必要 113 pytz がない場合、 Trac は内部で定義している 114 短いタイムゾーンの実装にフォールバックします 115 116 '''Attention''': これらの依存関係は様々なバージョンで必ずしも置き換えできるとは限らないので、上記のバージョン番号に注意してください。 Trac を動かす上で問題が発生した場合は [trac:MailingList メーリングリスト] や [trac:IrcChannel IRC チャネル] で質問をする前にすべての依存関係を再度確認してください。 117 118 これらのパッケージのドキュメンテーションを参照して、それらが最も上手にインストールできる方法を探してください。また [trac:TracInstallPlatforms プラットフォーム特有の説明] の多くに、これらの依存関係のインストール方法が記述されています。しかしながら [trac:TracInstallPlatforms プラットフォーム特有の説明] の情報はあなたがインストールしている Trac より古い バージョンについての説明があることを覚えておいてください (なんと Trac 0.8 に関する説明をしているページもあります)。 119 120 121 == Trac のインストール == #InstallingTrac 122 === `easy_install` を使用したインストール ===#Usingeasy_install 123 Trac をインストールする方法のひとつに [http://pypi.python.org/pypi/setuptools setuptools] の利用があります。 124 setuptools を使用すると、 Trac を Subversion リポジトリからインストールすることもできます。 125 126 例: 127 128 - Trac 1.0 をインストールします: 129 {{{ 130 easy_install Trac==1.0 131 }}} 132 (まだ有効になっていない場合) 133 - 開発中の最新バージョン 1.0dev をインストールします: 134 {{{ 135 easy_install Trac==dev 136 }}} 137 この場合、ローカライズに対応していないバージョンである可能性があります。 138 リリースされているバージョンを使用するか、ソースからインストールするようにしてください 139 140 === `pip` を使用したインストール === #Usingpip 141 'pip' は easy_install のリプレースであり、とても簡単に素早く Python パッケージをインストールすることができます。 142 Trac を 5 分程度でインストール、起動できます: 143 144 pip によってインストールされる場所を `/opt/user/trac` とした場合の例です: 145 146 - 147 {{{ 148 pip -E /opt/user/trac install trac psycopg2 149 }}} 150 または 151 - 152 {{{ 153 pip -E /opt/user/trac install trac mysql-python 154 }}} 155 156 PostgreSQL (libpq-dev) や MySQL (libmysqlclient-dev) へのバインディングも自動でビルドできるように、 pip が OS 固有のヘッダファイルを確実に利用できるようにして下さい。 157 158 また pip は (Genshi, Pygments などの) 依存関係を解決し、 pypi.python.org から最新のパッケージをダウンロードして、 `/opt/user/trac` の配下にインストールするところまで自動化されています。 159 160 すべてのコマンド (`tracd`, `trac-admin`) は `/opt/user/trac/bin` の配下にインストールされます。 `mod_python` (`PythonHandler` ディレクティブを使用する場合) や `mod_wsgi` (`WSGIDaemonProcess` ディレクティブを使用する場合) においても活用することができます。 161 162 加えて、 Trac プラグインのうちのいくつか ([http://pypi.python.org/pypi?:action=search&term=trac&submit=search ここ] で一覧を見ることができます) も pip からインストールすることが可能です。 163 164 165 166 === ソースからのインストール === #Fromsource 167 もちろん、ソースディレクトリのトップに格納されている setup.py を使用してインストールすることもできます。 168 169 (Trac-1.0.tar.gz など)リリースパッケージの .tar.gz や .zip ファイル、または直接リポジトリからソースを取得することが出来ます(詳細は Trac:SubversionRepository を参照してください)。 170 171 {{{ 172 $ python ./setup.py install 173 }}} 174 175 ``このステップを実行するためには root 権限 (または root 権限と同等の権限) が必要です。`` 176 177 この操作で Python のソースコードがバイトコンパイルされ、 .egg ファイルかディレクトリが Python インストールの `site-packages` ディレクトリにインストールされます。 178 .egg には htdocs や templates のようなソースファイル以外に標準の Trac が必要とするすべてのリソースが含まれています。 179 180 このスクリプトは [wiki:TracStandalone tracd] スタンドアロンサーバと一緒に、 [wiki:TracEnvironment プロジェクト Environment] を作成し維持するための [wiki:TracAdmin trac-admin] コマンドラインツールをインストールします。 181 182 ソースからインストールする場合や、新しい言語で Trac を国際化するためには Babel をインストールしておく必要があります。この場合も `install` を実行するだけです (Babel がインストールされていない状態で、すでに Trac をインストールしてしまった場合でも、 `install` をやり直すことで Babel サポートを有効化できます): 183 {{{ 184 $ python ./setup.py install 185 }}} 186 また、 `bdist_egg` を実行すると dist ディレクトリに作成される .egg ファイルをインストール先にコピーしたり、 (`bdist_wininst` の実行によって) Windows インストーラを作成しても構いません。 187 188 === 高度なオプション === #AdvancedOptions 189 190 Trac のインストール場所を変えるなどの高度なインストールオプションを知りたければ以下を実行してください: 191 {{{ 192 easy_install --help 193 }}} 194 195 詳細な情報は [http://docs.python.org/inst/inst.html Python モジュールをインストールする] を参照してください。 196 197 特にあなたは以下に興味を持つかもしれません: 198 {{{ 199 easy_install --prefix=/path/to/installdir 200 }}} 201 Mac OS X に Trac をインストールする場合: 202 {{{ 203 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 204 }}} 205 Note: Mac OS X 10.6 上で {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} を使用する場合は、オプションを指定しなくても {{{ /usr/local }}} および {{{ /Library/Python/2.6/site-packages }}} にインストールされます。 206 207 上記の例は、 `tracd` と `trac-admin` コマンドを `/usr/local/bin` に、 Trac のライブラリと依存ファイルを `/Library/Python/2.5/site-packages` にインストールします。これらのパスは Apple での Pyhton サードパーティアプリケーションの標準ロケーションです。(訳注: つまり、上記と違うパスにインストールしたい場合のみ、オプションの指定が必要になります) 208 209 210 == プロジェクト Environment の作成 == #CreatingaProjectEnvironment 211 212 [TracEnvironment Trac Environment] は Trac が Wiki ページ、チケット、レポート、設定などの情報を保存するバックエンドストレージです。基本的に人間が読み込み可能な [TracIni 構成ファイル] と他の様々なファイルやディレクトリで構成されます。 213 214 新しい Environment は [wiki:TracAdmin trac-admin] を使用して作成します: 215 {{{ 4 Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates will still be supported until at least Trac 1.5.1. 5 6 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. 7 8 If you're interested in contributing new translations for other languages or enhancing the existing translations, please have a look at [trac:wiki:TracL10N TracL10N]. 9 10 What 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], please '''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 * [https://www.python.org/ Python], version >= 2.7 and < 3.0 19 (note that we dropped the support for Python 2.6 in this release) 20 * [https://pypi.org/project/setuptools setuptools], version >= 0.6 21 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3 22 23 {{{#!div style="border: 1pt dotted; margin: 1em" 24 **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 [#DeployingTrac Deploying Trac]. 25 }}} 26 27 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. 28 29 ==== For the SQLite database #ForSQLite 30 31 You already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). 32 33 Optionally, you may install a newer version of [https://pypi.org/project/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details. 34 35 ==== For the PostgreSQL database #ForPostgreSQL 36 37 You need to install the database and its Python bindings: 38 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later 39 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later 40 41 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 42 43 ==== For the MySQL database #ForMySQL 44 45 Trac works well with MySQL, provided you use the following: 46 47 * [https://mysql.com/ MySQL], version 5.0 or later 48 * [https://pypi.org/project/PyMySQL PyMySQL] 49 50 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database. 51 52 === Optional Dependencies 53 54 ==== Subversion 55 56 [https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings. 57 58 There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information. 59 60 {{{#!div style="border: 1pt dotted; margin: 1em" 61 **Note:** 62 * Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings. 63 * If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported]. 64 }}} 65 66 For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page. 67 68 ==== Git 69 70 [https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page. 71 72 ==== Other Version Control Systems 73 74 Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem]. 75 76 ==== Web Server 77 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 78 79 Alternatively you can configure Trac to run in any of the following environments: 80 * [https://httpd.apache.org/ Apache] with 81 - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and 82 [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac]. 83 - [http://modpython.org/ mod_python 3.5.0], see TracModPython 84 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi) 85 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 86 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 87 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI]) 88 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 89 is highly discouraged''', better use one of the previous options. 90 91 92 ==== Other Python Packages 93 94 * [http://babel.pocoo.org Babel], version 0.9.6 or >= 1.3, 95 needed for localization support 96 * [http://docutils.sourceforge.net docutils], version >= 0.3.9 97 for WikiRestructuredText. 98 * [http://pygments.org Pygments] for 99 [TracSyntaxColoring syntax highlighting]. 100 * [https://pypi.org/project/textile Textile] for rendering the [https://github.com/textile/python-textile Textile markup language]. 101 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones, 102 otherwise Trac will fall back on a shorter list from 103 an internal time zone implementation. 104 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`. 105 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion]. 106 107 {{{#!div style="border: 1pt dotted; margin: 1em" 108 **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]. 109 }}} 110 111 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''. 112 113 == Installing Trac 114 115 The [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. 116 117 It is assumed throughout this guide that you have elevated permissions as the `root` user or by prefixing commands with `sudo`. The umask `0002` should be used for a typical installation on a Unix-based platform. 118 119 === Using `pip` 120 `pip` is the modern Python package manager and is included in Python 2.7.9 and later. Use [https://bootstrap.pypa.io/get-pip.py get-pip.py] to install `pip` for an earlier version of Python. 121 122 {{{#!sh 123 $ pip install Trac 124 }}} 125 126 `pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org. 127 128 You can also install directly from a source package. You can obtain the source in a tar or zip from the [trac:TracDownload] page. After extracting the archive, change to the directory containing `setup.py` and run: 129 130 {{{#!sh 131 $ pip install . 132 }}} 133 134 `pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples: 135 136 * Install the latest stable version from a zip archive: 137 {{{#!sh 138 $ pip install https://download.edgewall.org/trac/Trac-latest.zip 139 }}} 140 * Install the latest development version from a tar archive: 141 {{{#!sh 142 $ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz 143 }}} 144 * Install the unreleased 1.2-stable from subversion: 145 {{{#!sh 146 $ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.2-stable 147 }}} 148 * Install the latest development preview (//not recommended for production installs//): 149 {{{#!sh 150 $ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac 151 }}} 152 153 The optional dependencies can be installed from PyPI using `pip`: 154 {{{#!sh 155 $ pip install babel docutils pygments pytz textile 156 }}} 157 158 Additionally, you can install several Trac plugins from PyPI (listed [https://pypi.org/search/?c=Framework+%3A%3A+Trac here]) using pip. See TracPlugins for more information. 159 160 === Using installer 161 162 On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation. 163 164 === Using package manager 165 166 Trac may be available in your platform's package repository. However, your package manager may not provide the latest release of Trac. 167 168 == Creating a Project Environment 169 170 A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories. 171 172 A new environment is created using [TracAdmin trac-admin]: 173 {{{#!sh 216 174 $ trac-admin /path/to/myproject initenv 217 175 }}} 218 176 219 [TracAdmin trac-admin] は、プロジェクトの名前や [TracEnvironment#DatabaseConnectionStrings データベース接続文字列] など、 Environment を新規作成するために必要な情報を入力するためのプロンプトを表示します。これらの設定項目について特に変更が必要ない場合は、単に `<Enter>` を押下すると、デフォルト値が使用されます。 220 221 データベース接続文字列のデフォルトは SQLite が使用されます。 SQLite がインストールされている場合は、他の設定は不要です。 222 他の [trac:DatabaseBackend データベースバックエンド] を使用する場合は、あらかじめデータベースが使用可能な状態にしておかねばなりません。 223 224 0.12 以降で Trac は、新しい Environment の作成時に [TracEnvironment#SourceCodeRepository ソースコードリポジトリ] を尋ねないようになりました。リポジトリを後で [TracRepositoryAdmin 追加する] までの間、バージョン管理のサポートは無効化されます。 225 226 また、 ここで指定した値は [TracIni conf/trac.ini] 設定ファイルを直接編集することで後から変更できます。 227 228 最後に、 Web のフロントエンドを実行しているユーザアカウントは、 Environment のディレクトリと、その中のすべてのファイルに対する書き込み権限が必要です。 `trac-admin ... initenv` の実行を該当するユーザで実行した場合は、この作業は不要ですが、そうでない場合、ただしユーザに権限を付与する作業が必要になります。たとえば Linux で `apache` ユーザ `apache` グループで Web サーバを起動する場合は: 229 {{{ 230 # chown -R apache.apache /path/to/myproject 231 }}} 177 [TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value. 178 179 Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 180 181 Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file. 182 183 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: 184 {{{#!sh 185 $ chown -R apache:apache /path/to/myproject 186 }}} 187 188 The 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). 232 189 233 190 {{{#!div class=important 234 '''Warning:''' アカウント名とプロジェクトパスには ASCII 文字のみを使用して下さい。 unicode 文字はサポートしていません。 235 }}} 236 237 238 == Trac の利用 == #DeployingTrac 239 240 === スタンドアロンサーバの起動 === #RunningtheStandaloneServer 241 242 Trac 環境を作成した後に、スタンドアロンサーバ [wiki:TracStandalone tracd] を実行することで簡単に Web インタフェースを試すことができます。 243 {{{ 191 '''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there. 192 }}} 193 194 == Deploying Trac 195 196 {{{#!div style="border: 1pt dotted; margin: 1em" 197 **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. 198 199 If running `tracd`, 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. 200 201 To 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`. 202 {{{#!sh 203 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 204 }}} 205 206 Alternatively, the variable can be set in the shell before executing `tracd`: 207 {{{#!sh 208 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject 209 }}} 210 211 If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`. 212 }}} 213 214 === Running the Standalone Server 215 216 After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]: 217 {{{#!sh 244 218 $ tracd --port 8000 /path/to/myproject 245 219 }}} 246 220 247 ブラウザを起動して、 `http://localhost:8000/` にアクセスしてください。 `tracd` が認識しているすべての Environment の簡単な一覧が表示されます。作成した Environment へのリンクにアクセスすることで Trac が動作中であることを確認できます。 Trac でプロジェクトをひとつだけ管理したい場合、以下のように起動することで、スタンドアロンサーバは Environment 一覧の表示をスキップして、直接 Environment を表示します:248 {{{ 221 Then, open 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: 222 {{{#!sh 249 223 $ tracd -s --port 8000 /path/to/myproject 250 224 }}} 251 225 252 === Web サーバ上での Trac の起動 === #RunningTraconaWebServer 253 254 Trac には "実際の" Web サーバへ接続するために、いくつかの選択肢があります: 255 - [wiki:TracFastCgi FastCGI] 256 - [wiki:TracModWSGI mod_wsgi] 257 - //[wiki:TracModPython mod_python] (mod_python は現在活発なメンテナンスが行われていないため、推奨されません)// 258 - //[wiki:TracCgi CGI] (最適なパフォーマンスに遠く及ばないため、使用すべきではありません)// 259 260 Trac では [trac:TracOnWindowsIisAjp AJP] もサポートしており、IIS と接続したい場合に選択肢の一つとなるかもしれません。その他の選択肢もあります: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] 等。 261 262 ==== Trac の cgi-bin ディレクトリを生成する ==== #cgi-bin 263 264 Trac を FastCGI などで正しく機能させるには、 FastCGI であれば `trac.fcgi` ファイル、 mod_wsgi であれば `trac.wsgi` ファイルが必要となります。これらのファイルは適切な Python コードをロードする Python スクリプトです。 [wiki:TracAdmin trac-admin] コマンドの `deploy` オプションを使用することで生成できます。 265 266 若干の「卵が先か鶏が先か」問題があります。 [wiki:TracAdmin trac-admin] コマンドが機能するためには Environment が必要なのですが、 deploy には既に存在するディレクトリは使用できません。これに起因して、 Environment は depoly するディレクトリのサブディレクトリを使用することができません。この制限を回避するには次のようにします: 267 {{{ 268 mkdir -p /usr/share/trac/projects/my-project 269 trac-admin /usr/share/trac/projects/my-project initenv 270 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 271 mv /tmp/deploy/* /usr/share/trac 272 }}} 273 274 275 ==== 静的なリソースをマッピングする ==== #MappingStatcResources 276 277 特に設定することなく Trac はスタイルシートや画像のような静的なリソースを扱うことができます。tracd は唯一基本的な動作環境ですが、 Web サーバがそれら静的リソースを直接供給するように設定することより、はるかに最適になります。(CGI でセットアップした場合、'''極めて望ましくない''' し、著しい性能悪化の原因となります) 278 279 [http://httpd.apache.org/ Apache] のような Web サーバはリソースに対して "Alias" を設定することで仮想の URL を与え、サーバのファイルシステムのレイアウトとは異なる位置にマップすることができます。また、Trac自身によるこれらの要求に対する処理を避けて、直接ファイルシステム上のディレクトリへ静的リソースに対する要求をマッピングすることができます。 280 281 静的なリソースに対する主要な URL パスとして `/chrome/common` と `/chrome/site` があります。プラグインを使用している場合、各々の静的リソースとして `/chrome/<plugin>` のようなパスが追加されていることがありますが、主要なパスに対して追加を行えるだけなので、 `/chrome` に対して `Alias` を設定しても、プラグインが提供する静的リソースに対してアクセスできる訳ではありません。(訳注: このような場合 `trac-admin` の `deploy` で作成された `htdocs` ディレクトリに対して `Alias` を使用してください) 282 283 Note: ファイルシステムにおける静的なリソースを取得するためには、最初に [TracAdmin trac-admin] の ` <environment> deploy` コマンドを使用して、 Trac 関連のリソースを拡張する必要があります。 226 === Running Trac on a Web Server 227 228 Trac provides various options for connecting to a "real" web server: 229 - [TracFastCgi FastCGI] 230 - [wiki:TracModWSGI Apache with mod_wsgi] 231 - [TracModPython Apache with mod_python] 232 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)// 233 234 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], [https://uwsgi-docs.readthedocs.io/en/latest/#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc. 235 236 ==== Generating the Trac cgi-bin directory #cgi-bin 237 238 Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command: 284 239 [[TracAdminHelp(deploy)]] 285 240 286 ターゲットの `<directory>` は、以下のように `htdocs` ディレクトリに含まれます: 287 - `site/` - Environment 内の `htdocs/` ディレクトリのコピーです 288 - `common/` - Trac 自身が持つ静的なリソース 289 - `<plugins>/` - Environment で使用可能なプラグインによって管理される個々のリソースディレクトリ 290 291 ===== 例: Apache と `ScriptAlias` ===== #ScriptAlias-example 292 293 以下のような環境を仮定すると: 294 {{{ 295 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common 296 }}} 297 298 Apache の設定ファイル内において `ScriptAlias` や `WSGIScriptAlias` の記述(Trac アプリケーションへの他のすべてのリクエストに対するマップの記述) ''より上に'' 以下のブロックを追記します。 パスは環境に合わせ変更してください: 299 {{{ 241 Grant the web server execution right on scripts in the `cgi-bin` directory. 242 243 For example, the following yields a typical directory structure: 244 {{{#!sh 245 $ mkdir -p /var/trac 246 $ trac-admin /var/trac/<project> initenv 247 $ trac-admin /var/trac/<project> deploy /var/www 248 $ ls /var/www 249 cgi-bin htdocs 250 $ chmod ugo+x /var/www/cgi-bin/* 251 }}} 252 253 ==== Mapping Static Resources 254 255 Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance. 256 257 Web servers such as [https://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests. 258 259 There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path. 260 261 A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page. 262 263 The `deploy` command creates an `htdocs` directory with: 264 - `common/` - the static resources of Trac 265 - `site/` - a copy of the environment's `htdocs/` directory 266 - `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option 267 - `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment 268 269 The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases: 270 {{{#!apache 300 271 Alias /trac/chrome/common /path/to/trac/htdocs/common 301 272 Alias /trac/chrome/site /path/to/trac/htdocs/site 273 Alias /trac/chrome/shared /path/to/trac/htdocs/shared 274 Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin> 275 }}} 276 277 ===== Example: Apache and `ScriptAlias` #ScriptAlias-example 278 279 Assuming the deployment has been done this way: 280 {{{#!sh 281 $ trac-admin /var/trac/<project> deploy /var/www 282 }}} 283 284 Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application: 285 {{{#!apache 286 Alias /trac/chrome /path/to/trac/htdocs 302 287 303 288 <Directory "/path/to/www/trac/htdocs"> 304 Order allow,deny 305 Allow from all 289 # For Apache 2.2 290 <IfModule !mod_authz_core.c> 291 Order allow,deny 292 Allow from all 293 </IfModule> 294 # For Apache 2.4 295 <IfModule mod_authz_core.c> 296 Require all granted 297 </IfModule> 306 298 </Directory> 307 299 }}} 308 300 309 もし mod_python を使用している場合、この設定を追加した方が良いかもしれません(使用していない場合は、このエイリアスは無視されます):310 {{{ 311 <Location "/trac/chrome/common /">301 If using mod_python, add this too, otherwise the alias will be ignored: 302 {{{#!apache 303 <Location "/trac/chrome/common"> 312 304 SetHandler None 313 305 </Location> 314 306 }}} 315 307 316 Note: `trac.*cgi` スクリプトを `/trac` にマップしている場合、 `/trac/chrome/common` を加えたパスに対するリクエストは、静的リソースで処理するように割り込みを加えます。 317 318 同様に、静的なリソースを project の `htdocs` ディレクトリで使用している場合 (テーマの中で `/trac/chrome/site` を参照しているなど)、 これらのリソースを供給するよう Apache を設定することが出来ます。(再度、.*cgi スクリプトの `ScriptAlias` や `WSGIScriptAlias` ''より上に'' 以下のブロックを記述します。インストール状況に合わせて、ファイル名やロケーションは適宜変更してください): 319 {{{ 308 Alternatively, if you wish to serve static resources directly from your project's `htdocs` directory rather than the location to which the files are extracted with the `deploy` command, 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: 309 {{{#!apache 320 310 Alias /trac/chrome/site /path/to/projectenv/htdocs 321 311 322 312 <Directory "/path/to/projectenv/htdocs"> 323 Order allow,deny 324 Allow from all 313 # For Apache 2.2 314 <IfModule !mod_authz_core.c> 315 Order allow,deny 316 Allow from all 317 </IfModule> 318 # For Apache 2.4 319 <IfModule mod_authz_core.c> 320 Require all granted 321 </IfModule> 325 322 </Directory> 326 323 }}} 327 324 328 一方で `/trac/chrome/common` をエイリアスとするような場合、 Trac では [wiki:TracIni#trac-section| [trac] htdocs_location] を設定することで、それらリソースに対して直接リンクを生成することができます:329 {{{ 325 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-htdocs_location-option trac.htdocs_location] configuration setting: 326 {{{#!ini 330 327 [trac] 331 328 htdocs_location = http://static.example.org/trac-common/ 332 329 }}} 333 Note: これは 静的なリソースを供給する専用のドメインを簡単に設定します。([http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less]) 334 335 当然、Web サーバのドキュメントルートにディレクトリをコピーする(又は、リンクする)等して、特定の URL で Web サーバに接続できるよう Trac の `htdocs/common` ディレクトリを作成する必要があります。 336 {{{ 330 331 Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less. 332 333 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: 334 {{{#!sh 337 335 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 338 336 }}} 339 337 340 341 ==== プラグインキャッシュの設定 ==== #SettingupthePluginCache 342 343 Python プラグインの中にはキャッシュディレクトリを必要とするものがあります。デフォルトではキャッシュディレクトリは、現在のユーザのホームディレクトリに置かれます。 Trac を Web サーバで動作させている場合、ホームディレクトリを持たない専用ユーザであることが多く (強く推奨します)、プラグインの起動が妨げられることがあります。キャッシュディレクトリの場所を変更するには、環境変数 PYTHON_EGG_CACHE を設定してください。環境変数を設定する方法の詳細は使用しているサーバのドキュメントから参照してください。 344 345 == 認証の構成 == #ConfiguringAuthentication 346 347 Trac は HTTP 認証を使用します。`.../login` の URL ("ログイン"(英語版では "login") ボタンの仮想パス) がリクエストされた際に、認証を要求するように Web サーバを設定する必要があります。Trac は認証情報を得た後自動的に REMOTE_USER 変数を獲得します。そのため、すべてのユーザの管理は Web サーバ の設定で行います。設定方法等の詳細な情報は、利用している Web サーバのドキュメントを参照してください。 348 349 認証のためのユーザアカウントを追加、削除、設定する方法は Trac を起動する方法により異なります。 350 351 以下に記すセクションを適宜参照してください: 352 * スタンドアロンサーバ `tracd` を使用する場合は TracStandalone#UsingAuthentication 353 * Apache Web サーバ と `mod_wsgi` に代表される `mod_python` や `mod_fcgi`, `mod_fastcgi` といったフロントエンドを使用する場合は [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] 354 * Apache 以外の FCGI をサポートしている Web サーバ (Cherokee, Lighttpd, !LiteSpeed, nginx) を使用する場合 TracFastCgi 355 356 == admin ユーザへの管理者権限の付与 == #Grantingadminrightstotheadminuser 357 admin ユーザに管理者権限を付与します: 358 {{{ 338 ==== Setting up the Plugin Cache 339 340 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. 341 342 == Configuring Authentication 343 344 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. 345 346 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 347 348 Please refer to one of the following sections: 349 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 350 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`. 351 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 352 353 [trac:TracAuthenticationIntroduction] also contains some useful information for beginners. 354 355 == Granting admin rights to the admin user 356 Grant admin rights to user admin: 357 {{{#!sh 359 358 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 360 359 }}} 361 このユーザは Trac プロジェクトに管理者としてアクセスするため、メニュー内に "管理"(英語版では "Admin") が表示されます。 362 363 == インストールを終えて == #Finishingtheinstall 364 365 === SVN のチェンジセットを Trac のチケットに自動リンクする方法 === #AutomaticreferencetotheSVNchangesetsinTractickets 366 367 変更をリポジトリにコミットした時に、チェンジセットへのリンクをチケットのコメントに自動で追加するように SVN を設定することができます。コミットメッセージには以下に示すいずれかの書式が含まれていなければなりません: 368 * '''`Refs #123`''' - このチェンジセットへのリンクをチケット `#123` に追加します 369 * '''`Fixes #123`''' - このチェンジセットへのリンクをチケット `#123` に追加し、チケットを ''fixed'' でクローズします 370 371 この機能を使用するためには post-commit フックを [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin] に記載したリポジトリにインストールし、 commit updater コンポーネントを有効にせねばなりません。コンポーネントの有効化は、 [wiki:TracIni#components-section trac.ini] ファイルの `[components]` セクションに下記記述を追加するか、 "プラグイン" (英語版では "Plugins") 管理パネルから設定します。 372 {{{ 373 tracopt.ticket.commit_updater.* = enabled 374 }}} 375 詳細な情報は "プラグイン" 管理パネルの `CommitTicketUpdater` コンポーネントにあるドキュメントを参照してください。 376 377 == = Trac を使用する === #UsingTrac378 379 一度 Trac サイトを稼働させれば、チケットを作成したり、タイムラインを見たり、 (設定されていれば) バージョン管理のリポジトリを閲覧したりできるはずです。 380 381 //anonymous// (ログインしていない) でアクセスするユーザは、デフォルトではほとんど機能を使用することができません。特に、リソースに対して読み取りのみのアクセスになります。すべての機能を使用できるわけではないことに留意してください。すべての機能を使用するためには認証を構成して、認証されたユーザに対し [wiki:TracPermissions アクセス許可] を与える必要があります。 360 361 This user will have an //Admin// navigation item that directs to pages for administering your Trac project. 362 363 == Configuring Trac 364 365 Configuration options are documented on the TracIni page. 366 367 TracRepositoryAdmin provides information on configuring version control repositories for your project. 368 369 In addition to the optional version control backends, Trac provides several optional features that are disabled by default: 370 * [TracFineGrainedPermissions#AuthzPolicy Fine-grained permission policy] 371 * [TracPermissions#CreatingNewPrivileges Custom permissions] 372 * [TracTickets#deleter Ticket deletion] 373 * [TracTickets#cloner Ticket cloning] 374 * [TracRepositoryAdmin#CommitTicketUpdater Ticket changeset references] 375 376 == Using Trac 377 378 Once 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. 379 380 Keep 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. 382 381 383 382 '' Enjoy! '' … … 386 385 387 386 ---- 388 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade , TracPermissions387 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade