Changes between Initial Version and Version 1 of TracModPython


Ignore:
Timestamp:
2010/10/12 00:14:07 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracModPython

    v1 v1  
     1= Trac と mod_python = #Tracandmod_python 
     2[[TracGuideToc]] 
     3 
     4Trac では [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 
     10mod_python をインストールしたら、 Apache の設定ファイルに以下の一行を追加してモジュールをロードしなければなりません: 
     11{{{ 
     12LoadModule python_module modules/mod_python.so 
     13}}} 
     14 
     15''Note: モジュールがインストールされている正しいパスは HTTPD をどこにインストールしたかによって変わります。'' 
     16 
     17Debian で apt-get を使用する場合 
     18{{{ 
     19apt-get install libapache2-mod-python libapache2-mod-python-doc 
     20}}} 
     21(Debian の続き) mod_python をインストールした後に、apache2 (上の Load Module に相当するもの) のモジュールを有効にしなければなりません : 
     22{{{ 
     23a2enmod mod_python 
     24}}} 
     25Fedora で yum を使用する場合: 
     26{{{ 
     27yum install mod_python 
     28}}} 
     29httpd.conf に以下を加えることで、 mod_python がインストールされたかテストすることができます。セキュリティ上の理由から、テストが終わった時点で以下のコンフィグは削除するべきです。 Note: mod_python.testhandler は mod_python 3.2+ で利用可能です。 
     30{{{ 
     31#!xml 
     32<Location /mpinfo> 
     33   SetHandler mod_python 
     34   PythonInterpreter main_interpreter 
     35   PythonHandler mod_python.testhandler 
     36</Location> 
     37}}} 
     38 
     39mod_python を使用した簡単な Trac のセットアップ方法は以下のようになります: 
     40{{{ 
     41#!xml 
     42<Location /projects/myproject> 
     43   SetHandler mod_python 
     44   PythonInterpreter main_interpreter 
     45   PythonHandler trac.web.modpython_frontend  
     46   PythonOption TracEnv /var/trac/myproject 
     47   PythonOption TracUriRoot /projects/myproject 
     48</Location> 
     49}}} 
     50 
     51'''`TracUriRoot`''' オプションは不要な場合もあります。 `TracUriRoot` オプションを付けずに試し、 Trac が正しく URL を生成できないか、 "No handler matched request to..." というエラーが出るようであれば '''`TracUriRoot`''' を追加して下さい。 `Location` と '''`TracUriRoot`''' が同じパスになるようにしてください。 
     52 
     53!PythonOption の一覧は以下の通りです。 
     54{{{ 
     55    # For a single project 
     56    PythonOption TracEnv /var/trac/myproject 
     57    # For multiple projects 
     58    PythonOption TracEnvParentDir /var/trac/myprojects 
     59    # For the index of multiple projects 
     60    PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_template.html 
     61    # A space delimitted list, with a "," between key and value pairs. 
     62    PythonOption TracTemplateVars key1,val1 key2,val2 
     63    # Useful to get the date in the wanted order 
     64    PythonOption TracLocale en_GB.UTF8 
     65    # See description above         
     66    PythonOption TracUriRoot /projects/myproject 
     67}}} 
     68 
     69=== Python Egg Cache === #PythonEggCache 
     70 
     71Genshi のように圧縮された Python egg は通常、実行するユーザのホームディレクトリ配下の `.python-eggs` ディレクトリに展開されます。  Apache のホームディレクトリは多くの場合、書き込みできないようになっているので、他のディレクトリを egg cache として指定しなければなりません: 
     72{{{ 
     73PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache 
     74}}} 
     75 
     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 
     90Apache の mod_ldap 認証のコンフィグは少し扱いにくいです。(httpd 2.2.x と OpenLDAP: slapd 2.3.19) 
     91 
     921. Apache の httpd.conf に以下のモジュールをロードする必要があります 
     93{{{ 
     94LoadModule ldap_module modules/mod_ldap.so 
     95LoadModule authnz_ldap_module modules/mod_authnz_ldap.so 
     96}}} 
     97 
     982. 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 
     120Microsoft 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 
     145Note 1: このケースでは LDAP 検索で複数の OU をまとめて取得するために、 AD のグローバルカタログサーバ (Global Catalog Server) に接続しています (ポート番号が通常 LDAP で使用される 389 ではなく 3268 であることに注意してください) 。 GCS は基本的に "平らな" ツリーであり、ユーザが、どの OU に属するか不明な場合でも検索することができます。 
     146 
     147Note 2: Active Directory は、レコードにアクセスするために user/password (AuthLDAPBindDN と AuthLDAPBindPassword) による認証を必要とします。 (訳注: GC ではなく、通常の LDAP であれば Active Directory の ACL に認証なしユーザからの読み取り許可を設定すれば不要です) 
     148 
     149Note 3: "require ldap-group ..." ディレクティブはメンバのアクセスが許可されている AD のグループを指定します。 
     150 
     151 
     152=== Python Egg Cache を設定する === #SettingthePythonEggCache 
     153 
     154Web サーバが Egg Cache に書き込みできない場合、パーミッションを変更するか、 Apache が書き込み可能な場所を指定する必要があります。設定しないと ''500 Internal Server Error'' や syslog へのエラー出力が発生します。 
     155 
     156{{{ 
     157#!xml 
     158<Location /projects/myproject> 
     159  ... 
     160  PythonOption PYTHON_EGG_CACHE /tmp  
     161  ... 
     162</Location> 
     163}}} 
     164 
     165 
     166=== !PythonPath を設定する === #SettingthePythonPath 
     167 
     168もし Trac のインストールが、通常の Python ライブラリのパスの中に無い場合、 Apache が Trac の mod_python ハンドラを見つけられるように `PythonPath` ディレクティブで指定しなければなりません: 
     169{{{ 
     170#!xml 
     171<Location /projects/myproject> 
     172  ... 
     173  PythonPath "sys.path + ['/path/to/trac']" 
     174  ... 
     175</Location> 
     176}}} 
     177 
     178!PythonPath ディレクティブを使用するときは気をつけてください。そして、 `SetEnv PYTHONPATH` は動かないので ''使用しない'' で下さい。 
     179 
     180== マルチプロジェクトのセットアップ == #Settingupmultipleprojects 
     181 
     182Trac の mod_python ハンドラには Subversion の `SvnParentPath` とよく似た `TracEnvParentDir` というコンフィグレーションオプションがあります。 
     183{{{ 
     184#!xml 
     185<Location /projects> 
     186  SetHandler mod_python 
     187  PythonInterpreter main_interpreter 
     188  PythonHandler trac.web.modpython_frontend  
     189  PythonOption TracEnvParentDir /var/trac 
     190  PythonOption TracUriRoot /projects 
     191</Location> 
     192}}} 
     193 
     194`/projects` の URL をリクエストすると、 TracEnvironment の親ディレクトリ `TracEnvParentDir` として設定したディレクトリ配下のサブディレクトリ一覧が表示されます。その一覧から何かプロジェクトを選択するとそれに該当する TracEnvironment を開くことができます。 
     195 
     196あなたのプロジェクトのホームページとして、サブディレクトリのリストが必要ないならば、以下のようにすることができます 
     197{{{ 
     198#!xml 
     199<LocationMatch "/.+/"> 
     200}}} 
     201 
     202これは !DocumentRoot フォルダの直下にカスタムホームページとして配置されていない場合には、すべてのロケーションで代わりに mod_python を使用することを Apache に教えます。 
     203 
     204すべてのプロジェクトに対して、 `<LocationMatch>` ディレクティブを使用することによって同じ認証の仕組みを使用することができます。 
     205{{{ 
     206#!xml 
     207<LocationMatch "/projects/[^/]+/login"> 
     208  AuthType Basic 
     209  AuthName "Trac" 
     210  AuthUserFile /var/trac/.htpasswd 
     211  Require valid-user 
     212</LocationMatch> 
     213}}} 
     214 
     215== 仮想ホストの設定 == #VirtualHostConfiguration 
     216 
     217以下に示す例は Trac を仮想サーバーとしてセットアップするときに必要な設定です。 (例えば、!http://trac.mycompany.com といった 
     218URL でアクセスすることができます): 
     219 
     220{{{ 
     221#!xml 
     222<VirtualHost * > 
     223    DocumentRoot /var/www/myproject 
     224    ServerName trac.mycompany.com 
     225    <Location /> 
     226        SetHandler mod_python 
     227        PythonInterpreter main_interpreter 
     228        PythonHandler trac.web.modpython_frontend 
     229        PythonOption TracEnv /var/trac/myproject 
     230        PythonOption TracUriRoot / 
     231    </Location> 
     232    <Location /login> 
     233        AuthType Basic 
     234        AuthName "MyCompany Trac Server" 
     235        AuthUserFile /var/trac/myproject/.htpasswd 
     236        Require valid-user 
     237    </Location> 
     238</VirtualHost> 
     239}}} 
     240 
     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 
     248Note: !DocumentRoot は TracEnvironment と同じディレクトリにしないでください。 何かのバグがあった場合に TracEnvironment の内容が外部からアクセス可能になってしまうおそれがあります。 
     249 
     250== トラブルシューティング == #Troubleshooting 
     251 
     252サーバエラーのページがでたときには、 まずは Apache のエラーログを確認するか、 `PythonDebug` オプションを有効にして下さい: 
     253{{{ 
     254#!xml 
     255<Location /projects/myproject> 
     256  ... 
     257  PythonDebug on 
     258</Location> 
     259}}} 
     260 
     261複数プロジェクトの場合は、全てのプロジェクトでサーバを再起動してみてください。 
     262 
     263=== Expat-related のセグメンテーションフォルト === #expat 
     264 
     265この問題は Unix 上で Python 2.4 を使用するとき、ほぼ確実に発生します。 
     266Python 2.4 の使用する Expat (C で書かれた XML パーザライブラリ) と Apache の使用する Expat のバージョンが異なる場合に、セグメンテーションフォルトが発生します。 
     267Trac 0.11 は Genshi (間接的に Expat が使用される) を使用しているため、以前 Trac 0.10 で正常に動いていたとしても、現在のあなたの環境で問題が起こり得ます。 
     268 
     269Graham 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 
     283mod_python のバージョンによっては Zip された egg ファイルからモジュールを import できないことがあります。 Apache のログに `ImportError: No module named trac` が出力される場合、問題が発生している原因であると考えられます。 Python の site-packages ディレクトリを見てみてください; Trac のモジュールが ''ディレクトリ'' ではなく ''ファイル'' として配置されている場合、問題の原因と考えられます。解決するためには、下記の上に `--always-unzip` オプションと伴に Trac をインストールしてみてください。 
     284 
     285{{{ 
     286easy_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{{{ 
     297SetHandler mod_python 
     298PythonInterpreter main_interpreter 
     299PythonHandler trac.web.modpython_frontend  
     300PythonOption TracEnv /system/path/to/this/directory 
     301PythonOption TracUriRoot /path/on/apache 
     302 
     303AuthType Basic 
     304AuthName "ProjectName" 
     305AuthUserFile /path/to/.htpasswd 
     306Require valid-user 
     307}}} 
     308 
     309`TracUriRoot` は Web ブラウザが取得する Trac のパスを明示的に設定するのに使用します。 (例: domain.tld/projects/trac) 
     310 
     311=== .htaccess 使用時の特記事項 === #Additional.htaccesshelp 
     312 
     313.htaccess を使用している場合、 Trac のディレクトリが他のディレクトリで設定されたた .htaccess ディレクティブを継承し、問題を生じることがあります。このような場合、以下のように .htaccess ファイルに設定してみて下さい: 
     314 
     315{{{ 
     316<IfModule mod_rewrite.c> 
     317  RewriteEngine Off 
     318</IfModule> 
     319}}} 
     320 
     321 
     322=== Win32 での特記 === #Win32Issues 
     323Windows 上で mod_python 3.2 より前のバージョンで Trac を動かしている場合、添付ファイルのアップロードが '''動かない''' でしょう。この問題は 3.1.4 以降で解決されました。 mod_python をアップグレードしてこの問題を解決してください。 
     324 
     325 
     326=== OS X での特記 === #OSXissues 
     327 
     328OS 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リポジトリに セキュリティコンテキストを設定する必要があるでしょう: 
     334 
     335{{{ 
     336chcon -R -h -t httpd_sys_content_t PATH_TO_REPOSITORY 
     337}}} 
     338 
     339[http://subversion.tigris.org/faq.html#reposperms] も参考にして下さい 
     340 
     341=== FreeBSD での特記 === #FreeBSDissues 
     342mod_python と sqlite パッケージのインストールバージョンに注意して下さい。 Ports には両パッケージともいろいろなバージョンがありますが、初期の pysqlite と mod_python は組み合わせることができません。前者は python のスレッド機能サポートが必要ですし、 後者 は python のスレッド機能なしのインストールが必要です。 
     343 
     344apache2 を普通にコンパイルしてインストールした場合、 apache はスレッドのサポートなしになります (これが FreeBSD 上であまりよく動かない原因)。 --enable-threads を使用して ./configure を実行することで apache にスレッドのサポートありにすることができますが、これはお勧めできません。 
     345最良のオプションは /usr/local/apache2/bin/ennvars に下記の一行を追加することだと [http://modpython.org/pipermail/mod_python/2006-September/021983.html 考えられます。] 
     346 
     347{{{ 
     348export LD_PRELOAD=/usr/lib/libc_r.so 
     349}}} 
     350 
     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] に記述されている通り、メインインタプリタを使用するように強制するワークアラウンドを使用する方がおそらく良いでしょう: 
     358{{{ 
     359PythonInterpreter main_interpreter 
     360}}} 
     361これは、よく知られている mod_python と Subversion の Python バインディングの他の問題 ([http://trac.edgewall.org/ticket/2611 #2611], [http://trac.edgewall.org/ticket/3455 #3455]) について推奨しているワークアラウンドです。 [http://trac.edgewall.org/ticket/3455#comment:9 #3455] Graham Dumpleton のコメントに問題点が指摘されています。 
     362 
     363=== ページレイアウトの問題 === #Pagelayoutissues 
     364 
     365Trac のページフォーマットが奇妙に見えるなら、ページレイアウトを管理するスタイルシートが Web サーバによって適切に扱われていない可能性が考えられます。 Apache のコンフィグに以下を追加してみてください: 
     366{{{ 
     367#!xml 
     368Alias /myproject/css "/usr/share/trac/htdocs/css" 
     369<Location /myproject/css> 
     370    SetHandler None 
     371</Location> 
     372}}} 
     373 
     374Note: 上記のコンフィグが効果を発揮するためには、プロジェクトの root 位置のコンフィグ後に追加しなければなりません。つまり {{{<Location /myproject />}}} 以降です。 
     375 
     376また `PythonOptimize On` が設定されている場合、ページのヘッダとフッタの表示が乱れたり、マクロやプラグインのドキュメンテーションが表示されないことがあります ([http://trac.edgewall.org/ticket/8956 #8956] 参照)。オプションの設定によって影響を受ける箇所について充分考慮できない場合は `Off` に設定する方がよいでしょう。 
     377 
     378=== HTTPS の問題 === #HTTPSissues 
     379 
     380Trac を完全に https で実行したいにも関わらず、プレーンな http にリダイレクトされる場合、 Apache のコンフィグに以下を追加してください: 
     381{{{ 
     382#!xml 
     383<VirtualHost * > 
     384    DocumentRoot /var/www/myproject 
     385    ServerName trac.mycompany.com 
     386    SetEnv HTTPS 1 
     387    .... 
     388</VirtualHost> 
     389}}} 
     390 
     391=== Fedora 7 の問題 === #Fedora7Issues 
     392必ず 'python-sqlite2' をインストールしてください。 TracModPython では必須です (tracd では必須ではありません)。 
     393 
     394 
     395=== php5-mhash または その他の php5 モジュールのセグメンテーションフォルト === #Segmentationfaultwithphp5-mhashorotherphp5modules 
     396php5-mhash モジュールがインストールされている場合、 (debian etch について報告された) セグメンテーションフォルトに遭遇するでしょう。 php-mhash を削除して、問題が解決するかを確かめてみてください。 debian のバグレポート [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=411487] を参考にして下さい。 
     397 
     398システムライブラリの代わりに、サードパーティのライブラリでコンパイルされた php5 を使用する一部の人々にもトラブルが発生します。ここを確認してください [http://www.djangoproject.com/documentation/modpython/#if-you-get-a-segmentation-fault] 
     399 
     400---- 
     401See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracFastCgi FastCGI],  [http://trac.edgewall.org/wiki/TracNginxRecipe TracNginxRecipe]