| 4 | | Trac では [http://www.modpython.org/ mod_python] を利用可能です。 [http://www.modpython.org/ mod_python] は Trac のレスポンスタイムを飛躍的に向上し、特に [TracCgi CGI] と比べて、 [wiki:TracStandalone tracd]/mod_proxy では使用できない多くの Apache 機能を使えるようにします。 |
| 5 | | |
| 6 | | 以下の説明は Apache2 のためのものです; まだ Apache1.3 を使用しているなら、 [http://trac.edgewall.org/wiki/TracModPython2.7 TracModPython2.7] にいくつか情報があります。 |
| 7 | | |
| 8 | | == シンプルなコンフィグレーション == #Simpleconfiguration |
| 9 | | |
| 10 | | mod_python をインストールしたら、 Apache の設定ファイルに以下の一行を追加してモジュールをロードしなければなりません: |
| | 4 | Trac supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably, especially compared to [TracCgi CGI], and permits use of many Apache features not possible with [wiki:TracStandalone tracd]/mod_proxy. |
| | 5 | |
| | 6 | {{{#!div class="important" |
| | 7 | ** A Word of Warning ** |
| | 8 | |
| | 9 | As of 16^th^ June 2010, the mod_python project is officially dead. If you are considering using mod_python for a new installation, '''please don't'''! There are known issues which will not be fixed and there are now better alternatives. Check out the main TracInstall pages for your target version for more information. |
| | 10 | }}} |
| | 11 | |
| | 12 | |
| | 13 | These instructions are for Apache 2; if you are still using Apache 1.3, you may have some luck with [trac:wiki:TracModPython2.7 TracModPython2.7], but you'll be totally on your own. |
| | 14 | |
| | 15 | [[PageOutline(2-3,Overview,inline)]] |
| | 16 | |
| | 17 | == Simple configuration: single project == #Simpleconfiguration |
| | 18 | |
| | 19 | If you just installed mod_python, you may have to add a line to load the module in the Apache configuration: |
| 76 | | または Genshi の egg を解凍して展開することで、この問題を回避できます。 |
| 77 | | === 認証設定 === #ConfiguringAuthentication |
| 78 | | |
| 79 | | パスワードファイルを作成して、認証を構成するには [wiki:TracCgi#AddingAuthentication CGI] と同じように行います。 |
| 80 | | {{{ |
| 81 | | #!xml |
| 82 | | <Location /projects/myproject/login> |
| 83 | | AuthType Basic |
| 84 | | AuthName "myproject" |
| 85 | | AuthUserFile /var/trac/myproject/.htpasswd |
| 86 | | Require valid-user |
| 87 | | </Location> |
| 88 | | }}} |
| 89 | | |
| 90 | | Apache の mod_ldap 認証のコンフィグは少し扱いにくいです。(httpd 2.2.x と OpenLDAP: slapd 2.3.19) |
| 91 | | |
| 92 | | 1. Apache の httpd.conf に以下のモジュールをロードする必要があります |
| 93 | | {{{ |
| 94 | | LoadModule ldap_module modules/mod_ldap.so |
| 95 | | LoadModule authnz_ldap_module modules/mod_authnz_ldap.so |
| 96 | | }}} |
| 97 | | |
| 98 | | 2. httpd.conf は以下のような感じになります: |
| 99 | | |
| 100 | | {{{ |
| 101 | | #!xml |
| 102 | | <Location /trac/> |
| 103 | | SetHandler mod_python |
| 104 | | PythonInterpreter main_interpreter |
| 105 | | PythonHandler trac.web.modpython_frontend |
| 106 | | PythonOption TracEnv /home/trac/ |
| 107 | | PythonOption TracUriRoot /trac/ |
| 108 | | Order deny,allow |
| 109 | | Deny from all |
| 110 | | Allow from 192.168.11.0/24 |
| 111 | | AuthType Basic |
| 112 | | AuthName "Trac" |
| 113 | | AuthBasicProvider "ldap" |
| 114 | | AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)" |
| 115 | | authzldapauthoritative Off |
| 116 | | require valid-user |
| 117 | | </Location> |
| 118 | | }}} |
| 119 | | |
| 120 | | Microsoft Active Directory の LDAP インタフェースを使用する場合: |
| 121 | | |
| 122 | | {{{ |
| 123 | | #!xml |
| 124 | | <Location /trac/> |
| 125 | | SetHandler mod_python |
| 126 | | PythonInterpreter main_interpreter |
| 127 | | PythonHandler trac.web.modpython_frontend |
| 128 | | PythonOption TracEnv /home/trac/ |
| 129 | | PythonOption TracUriRoot /trac/ |
| 130 | | Order deny,allow |
| 131 | | Deny from all |
| 132 | | Allow from 192.168.11.0/24 |
| 133 | | AuthType Basic |
| 134 | | AuthName "Trac" |
| 135 | | AuthBasicProvider "ldap" |
| 136 | | AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)" |
| 137 | | AuthLDAPBindDN ldap-auth-user@company.com |
| 138 | | AuthLDAPBindPassword "the_password" |
| 139 | | authzldapauthoritative Off |
| 140 | | # require valid-user |
| 141 | | require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com |
| 142 | | </Location> |
| 143 | | }}} |
| 144 | | |
| 145 | | Note 1: このケースでは LDAP 検索で複数の OU をまとめて取得するために、 AD のグローバルカタログサーバ (Global Catalog Server) に接続しています (ポート番号が通常 LDAP で使用される 389 ではなく 3268 であることに注意してください) 。 GCS は基本的に "平らな" ツリーであり、ユーザが、どの OU に属するか不明な場合でも検索することができます。 |
| 146 | | |
| 147 | | Note 2: Active Directory は、レコードにアクセスするために user/password (AuthLDAPBindDN と AuthLDAPBindPassword) による認証を必要とします。 (訳注: GC ではなく、通常の LDAP であれば Active Directory の ACL に認証なしユーザからの読み取り許可を設定すれば不要です) |
| 148 | | |
| 149 | | Note 3: "require ldap-group ..." ディレクティブはメンバのアクセスが許可されている AD のグループを指定します。 |
| 150 | | |
| 151 | | |
| 152 | | === Python Egg Cache を設定する === #SettingthePythonEggCache |
| 153 | | |
| 154 | | Web サーバが Egg Cache に書き込みできない場合、パーミッションを変更するか、 Apache が書き込み可能な場所を指定する必要があります。設定しないと ''500 Internal Server Error'' や syslog へのエラー出力が発生します。 |
| | 94 | or you can uncompress the Genshi egg to resolve problems extracting from it. |
| | 95 | |
| | 96 | === Configuring Authentication === |
| | 97 | |
| | 98 | See corresponding section in the [wiki:TracModWSGI#ConfiguringAuthentication] page. |
| | 99 | |
| | 100 | |
| | 101 | == Advanced Configuration |
| | 102 | |
| | 103 | === Setting the Python Egg Cache === |
| | 104 | |
| | 105 | If the Egg Cache isn't writeable by your Web server, you'll either have to change the permissions, or point Python to a location where Apache can write. This can manifest itself as a ''500 internal server error'' and/or a complaint in the syslog. |
| 241 | | この設定は全てのケースでうまく動くわけではありません。動かない場合は以下を試してください: |
| 242 | | * `<Location>` の代わりに `<LocationMatch>` を使用する。 |
| 243 | | * <Location /> はサーバの設定によっては、単にサーバのルートではなく完全なホスト名を参照していることがあります。このような場合、 (上記の例では下段にあたるログイン用ディレクトリを含む) 全てのリクエストが Python に送信され、認証が動かなくなります (認証を行おうとすると、認証が設定されていないというエラー画面が表示されます)。 URL を変更できるのであれば (/, /login の代わりに /web/, /web/login などのように) ルートではなくサブディレクトリを使ってみてください。 |
| 244 | | * Apache の `NameVirtualHost` を設定している場合、 `<VirtualHost *>` ではなく `<VirtualHost *:80>` を使用せねばならないかもしれません。 |
| 245 | | |
| 246 | | 複数のプロジェクトをサポートする仮想ホストの設定では、 "`TracEnv`" /var/trac/myproject を "`TracEnvParentDir`" /var/trac/ に置き換えて下さい。 |
| 247 | | |
| 248 | | Note: !DocumentRoot は TracEnvironment と同じディレクトリにしないでください。 何かのバグがあった場合に TracEnvironment の内容が外部からアクセス可能になってしまうおそれがあります。 |
| 249 | | |
| 250 | | == トラブルシューティング == #Troubleshooting |
| 251 | | |
| 252 | | サーバエラーのページがでたときには、 まずは Apache のエラーログを確認するか、 `PythonDebug` オプションを有効にして下さい: |
| | 192 | This does not seem to work in all cases. What you can do if it does not: |
| | 193 | * Try using `<LocationMatch>` instead of `<Location>` |
| | 194 | * <Location /> may, in your server setup, refer to the complete host instead of simple the root of the server. This means that everything (including the login directory referenced below) will be sent to python and authentication does not work (i.e. you get the infamous Authentication information missing error). If this applies to you, try using a sub-directory for trac instead of the root (i.e. /web/ and /web/login instead of / and /login). |
| | 195 | * Depending on apache's `NameVirtualHost` configuration, you may need to use `<VirtualHost *:80>` instead of `<VirtualHost *>`. |
| | 196 | |
| | 197 | For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/ |
| | 198 | |
| | 199 | Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserver bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment". |
| | 200 | |
| | 201 | == Troubleshooting == |
| | 202 | |
| | 203 | In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option: |
| 261 | | 複数プロジェクトの場合は、全てのプロジェクトでサーバを再起動してみてください。 |
| 262 | | |
| 263 | | === Expat-related のセグメンテーションフォルト === #expat |
| 264 | | |
| 265 | | この問題は Unix 上で Python 2.4 を使用するとき、ほぼ確実に発生します。 |
| 266 | | Python 2.4 の使用する Expat (C で書かれた XML パーザライブラリ) と Apache の使用する Expat のバージョンが異なる場合に、セグメンテーションフォルトが発生します。 |
| 267 | | Trac 0.11 は Genshi (間接的に Expat が使用される) を使用しているため、以前 Trac 0.10 で正常に動いていたとしても、現在のあなたの環境で問題が起こり得ます。 |
| 268 | | |
| 269 | | Graham Dumpleton が、この問題について詳しく書いています。問題の [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash 説明と回避方法] を確認してください。 |
| 270 | | |
| 271 | | === フォームを送信するときの問題 === #Formsubmissionproblems |
| 272 | | |
| 273 | | もし、 Trac で何かしらのフォームを送信したときに、トラブルに見舞われたら (送信後にスタートページにリダイレクトされてしまう、などがよくある問題です) {{{DocumentRoot}}} の中に mod_python をマッピングしたパスと同じフォルダやファイルが存在しないか確認してください。どういうわけか、 mod_python は静的リソースと同じところにマッピングされると混乱してしまいます。 |
| 274 | | |
| 275 | | === 仮想ホストの設定においての問題 === #Problemwithvirtualhostconfiguration |
| 276 | | |
| 277 | | <Location /> ディレクティブが使用されている場合に `DocumentRoot` を設定すると ''403 (Forbidden)'' エラーになることがあります。 `DocumentRoot` ディレクティブを削除するか、アクセスが許されているディレクトリに設定されているかどうかを確認して下さい (対応する `<Directory>` ブロックにて) |
| 278 | | |
| 279 | | <Location /> で `SetHandler` を使用すると、すべてを mod_python でハンドルすることになりますが、いかなる CSS も image/icons もダウンロードできなくなります。この問題を回避するために、われわれは <Location /trac> で `SetHandler None` を使用しています。しかし、この方法がエレガントな解決方法だとは思っていません。 |
| 280 | | |
| 281 | | === Zip された egg での問題 === #Problemwithzippedegg |
| 282 | | |
| 283 | | mod_python のバージョンによっては Zip された egg ファイルからモジュールを import できないことがあります。 Apache のログに `ImportError: No module named trac` が出力される場合、問題が発生している原因であると考えられます。 Python の site-packages ディレクトリを見てみてください; Trac のモジュールが ''ディレクトリ'' ではなく ''ファイル'' として配置されている場合、問題の原因と考えられます。解決するためには、下記の上に `--always-unzip` オプションと伴に Trac をインストールしてみてください。 |
| 284 | | |
| 285 | | {{{ |
| 286 | | easy_install --always-unzip Trac-0.12.zip |
| 287 | | }}} |
| 288 | | |
| 289 | | === .htaccess ファイルを使用する === #Using.htaccess |
| 290 | | |
| 291 | | ディレクトリの設定をほんのちょっと修正するには `.htaccess` ファイルを使用すればいいかもしれませんが、これは動作しません。 Apache が Trac の URL に "/" (スラッシュ) を追加すると、正しい動作を妨げてしまいます。 |
| 292 | | |
| 293 | | それでは、 mod_rewrite を使用すればいいように見えますが、これも動作しません。とにかく、百害あって一利なしです。指示に従ってください。 :) |
| 294 | | |
| 295 | | 成功した事例: 以下の設定値で成功した事例があります: |
| 296 | | {{{ |
| | 212 | For multiple projects, try restarting the server as well. |
| | 213 | |
| | 214 | === Login Not Working === |
| | 215 | If you've used `<Location />` directive, it will override any other directives, as well as `<Location /login>`. |
| | 216 | The workaround is to use negation expression as follows (for multi project setups): |
| | 217 | {{{ |
| | 218 | #!xml |
| | 219 | #this one for other pages |
| | 220 | <Location ~ "/*(?!login)"> |
| | 221 | SetHandler mod_python |
| | 222 | PythonHandler trac.web.modpython_frontend |
| | 223 | PythonOption TracEnvParentDir /projects |
| | 224 | PythonOption TracUriRoot / |
| | 225 | |
| | 226 | </Location> |
| | 227 | #this one for login page |
| | 228 | <Location ~ "/[^/]+/login"> |
| | 229 | SetHandler mod_python |
| | 230 | PythonHandler trac.web.modpython_frontend |
| | 231 | PythonOption TracEnvParentDir /projects |
| | 232 | PythonOption TracUriRoot / |
| | 233 | |
| | 234 | #remove these if you don't want to force SSL |
| | 235 | RewriteEngine On |
| | 236 | RewriteCond %{HTTPS} off |
| | 237 | RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
| | 238 | |
| | 239 | AuthType Basic |
| | 240 | AuthName "Trac" |
| | 241 | AuthUserFile /projects/.htpasswd |
| | 242 | Require valid-user |
| | 243 | </Location> |
| | 244 | }}} |
| | 245 | |
| | 246 | === Expat-related segmentation faults === #expat |
| | 247 | |
| | 248 | This problem will most certainly hit you on Unix when using Python 2.4. |
| | 249 | In Python 2.4, some version of Expat (an XML parser library written in C) is used, |
| | 250 | and if Apache is using another version, this results in segmentation faults. |
| | 251 | As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem |
| | 252 | can now hit you even if everything was working fine before with Trac 0.10. |
| | 253 | |
| | 254 | See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue. |
| | 255 | |
| | 256 | === Form submission problems === |
| | 257 | |
| | 258 | If you're experiencing problems submitting some of the forms in Trac (a common problem is that you get redirected to the start page after submission), check whether your {{{DocumentRoot}}} contains a folder or file with the same path that you mapped the mod_python handler to. For some reason, mod_python gets confused when it is mapped to a location that also matches a static resource. |
| | 259 | |
| | 260 | === Problem with virtual host configuration === |
| | 261 | |
| | 262 | If the <Location /> directive is used, setting the `DocumentRoot` may result in a ''403 (Forbidden)'' error. Either remove the `DocumentRoot` directive, or make sure that accessing the directory it points is allowed (in a corresponding `<Directory>` block). |
| | 263 | |
| | 264 | Using <Location /> together with `SetHandler` resulted in having everything handled by mod_python, which leads to not being able download any CSS or images/icons. I used <Location /trac> `SetHandler None` </Location> to circumvent the problem, though I do not know if this is the most elegant solution. |
| | 265 | |
| | 266 | === Problem with zipped egg === |
| | 267 | |
| | 268 | It's possible that your version of mod_python will not import modules from zipped eggs. If you encounter an `ImportError: No module named trac` in your Apache logs but you think everything is where it should be, this might be your problem. Look in your site-packages directory; if the Trac module appears as a ''file'' rather than a ''directory'', then this might be your problem. To rectify, try installing Trac using the `--always-unzip` option, like this: |
| | 269 | |
| | 270 | {{{ |
| | 271 | easy_install --always-unzip Trac-0.12b1.zip |
| | 272 | }}} |
| | 273 | |
| | 274 | === Using .htaccess === |
| | 275 | |
| | 276 | Although it may seem trivial to rewrite the above configuration as a directory in your document root with a `.htaccess` file, this does not work. Apache will append a "/" to any Trac URLs, which interferes with its correct operation. |
| | 277 | |
| | 278 | It may be possible to work around this with mod_rewrite, but I failed to get this working. In all, it is more hassle than it is worth. Stick to the provided instructions. :) |
| | 279 | |
| | 280 | A success story: For me it worked out-of-box, with following trivial config: |
| | 281 | {{{#!xml |
| 321 | | |
| 322 | | === Win32 での特記 === #Win32Issues |
| 323 | | Windows 上で mod_python 3.2 より前のバージョンで Trac を動かしている場合、添付ファイルのアップロードが '''動かない''' でしょう。この問題は 3.1.4 以降で解決されました。 mod_python をアップグレードしてこの問題を解決してください。 |
| 324 | | |
| 325 | | |
| 326 | | === OS X での特記 === #OSXissues |
| 327 | | |
| 328 | | OS X で mod_python を使用するとき、 `apachectl restart` コマンドで Apache の再起動ができないでしょう。これは、 mod_python 3.2 でおそらく修正されるでしょう。しかし、 [http://www.dscpl.com.au/projects/vampire/patches.html ここ] にあるパッチを適用すれば、 3.2 以前のバージョンでもこの問題を回避できます。 |
| 329 | | |
| 330 | | === SELinux での特記 === #SELinuxissues |
| 331 | | |
| 332 | | もし、 Trac が ''Cannot get shared lock on db.lock'' というようなメッセージが出力したら、 |
| 333 | | リポジトリに セキュリティコンテキストを設定する必要があるでしょう: |
| | 306 | === Platform specific issues |
| | 307 | ==== Win32 Issues ==== |
| | 308 | If you run trac with mod_python < 3.2 on Windows, uploading attachments will '''not''' work. This problem is resolved in mod_python 3.1.4 or later, so please upgrade mod_python to fix this. |
| | 309 | |
| | 310 | |
| | 311 | ==== OS X issues ==== |
| | 312 | |
| | 313 | When using mod_python on OS X you will not be able to restart Apache using `apachectl restart`. This is apparently fixed in mod_python 3.2, but there's also a patch available for earlier versions [http://www.dscpl.com.au/projects/vampire/patches.html here]. |
| | 314 | |
| | 315 | ==== SELinux issues ==== |
| | 316 | |
| | 317 | If Trac reports something like: ''Cannot get shared lock on db.lock'' |
| | 318 | The security context on the repository may need to be set: |
| 339 | | [http://subversion.tigris.org/faq.html#reposperms] も参考にして下さい |
| 340 | | |
| 341 | | === FreeBSD での特記 === #FreeBSDissues |
| 342 | | mod_python と sqlite パッケージのインストールバージョンに注意して下さい。 Ports には両パッケージともいろいろなバージョンがありますが、初期の pysqlite と mod_python は組み合わせることができません。前者は python のスレッド機能サポートが必要ですし、 後者 は python のスレッド機能なしのインストールが必要です。 |
| 343 | | |
| 344 | | apache2 を普通にコンパイルしてインストールした場合、 apache はスレッドのサポートなしになります (これが FreeBSD 上であまりよく動かない原因)。 --enable-threads を使用して ./configure を実行することで apache にスレッドのサポートありにすることができますが、これはお勧めできません。 |
| 345 | | 最良のオプションは /usr/local/apache2/bin/ennvars に下記の一行を追加することだと [http://modpython.org/pipermail/mod_python/2006-September/021983.html 考えられます。] |
| | 324 | See also [http://subversion.tigris.org/faq.html#reposperms] |
| | 325 | |
| | 326 | ==== FreeBSD issues ==== |
| | 327 | Pay attention to the version of the installed mod_python and sqlite packages. Ports have both the new and old ones, but earlier versions of pysqlite and mod_python won't integrate as the former requires threaded support in python, and the latter requires a threadless install. |
| | 328 | |
| | 329 | If you compiled and installed apache2, apache wouldn´t support threads (cause it doesn´t work very well on FreeBSD). You could force thread support when running ./configure for apache, using --enable-threads, but this isn´t recommendable. |
| | 330 | The best option [http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be] adding to /usr/local/apache2/bin/ennvars the line |
| 351 | | === Subversion での特記 === #Subversionissues |
| 352 | | |
| 353 | | コマンドラインや TracStandalone で使用しているときは動くのに、 mod_python を使用しているときのみ、 `Unsupported version control system "svn"` というエラーが出力される場合、 [wiki:"TracModPython#SettingthePythonPath" PythonPath] ディレクティブに Python bindings へのパスを追加するのを忘れている可能性があります。 (Python の `site-packages` ディレクトリに Python binding へのリンクを追加するか、 `.pth` ファイルを作っておくのがベターです。) |
| 354 | | |
| 355 | | これに当てはまらない場合、使用している Subversion のライブラリが Apache が使用しているバージョンと適合性がないかもしれません。 (たいてい `apr` ライブラリの不適合性が原因になります。) その場合、 Apache の svn モジュール (`mod_dav_svn`) も使用できないでしょう。 |
| 356 | | |
| 357 | | また、ランタイムエラー ({{{argument number 2: a 'apr_pool_t *' is expected}}}) を抑止するためにも、複数のサブインタプリタを使用できる最近のバージョンの `mod_python` が必要になります。 3.2.8 では ''たぶん'' 動きますが、 [http://trac.edgewall.org/ticket/3371 #3371] に記述されている通り、メインインタプリタを使用するように強制するワークアラウンドを使用する方がおそらく良いでしょう: |
| | 336 | |
| | 337 | ==== Fedora 7 Issues ==== |
| | 338 | Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd |
| | 339 | |
| | 340 | |
| | 341 | === Subversion issues === |
| | 342 | |
| | 343 | If you get the following Trac Error `Unsupported version control system "svn"` only under mod_python, though it works well on the command-line and even with TracStandalone, chances are that you forgot to add the path to the Python bindings with the [TracModPython#ConfiguringPythonPath PythonPath] directive. (The better way is to add a link to the bindings in the Python `site-packages` directory, or create a `.pth` file in that directory.) |
| | 344 | |
| | 345 | If this is not the case, it's possible that you're using Subversion libraries that are binary incompatible with the apache ones (an incompatibility of the `apr` libraries is usually the cause). In that case, you also won't be able to use the svn modules for Apache (`mod_dav_svn`). |
| | 346 | |
| | 347 | You also need a recent version of `mod_python` in order to avoid a runtime error ({{{argument number 2: a 'apr_pool_t *' is expected}}}) due to the default usage of multiple sub-interpreters. 3.2.8 ''should'' work, though it's probably better to use the workaround described in [trac:#3371 #3371], in order to force the use of the main interpreter: |
