Changes between Initial Version and Version 1 of TracFastCgi


Ignore:
Timestamp:
06/04/12 12:01:35 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracFastCgi

    v1 v1  
     1= Trac を FastCGI で使用する = #TracwithFastCGI 
     2 
     3バージョン 0.9 以降、 Trac は [http://www.fastcgi.com/ FastCGI] インタフェースに対応するようになりました。 [wiki:TracModPython mod_python] 同様、 Trac を常駐させるため、外部の各リクエストに対して新しいプロセスを生成する CGI インタフェースよりも処理速度が速いです。その上 `mod_python` とは異なり [http://httpd.apache.org/docs/suexec.html SuEXEC] に対応することも可能です。また、より多くの種類の Web サーバにサポートされています。 
     4 
     5'''Note for Windows:''' Trac's FCGI does not run under Windows, as Windows does not implement `Socket.fromfd`, which is used by `_fcgi.py`. If you want to connect to IIS, your choice may be [trac:TracOnWindowsIisAjp AJP]. 
     6'''Windows 向けの Note:''' Trac の FCGI は Windows では使用できません。 `_fcgi.py` が必要とする `Socket.fromfd` が Windows では実装されていないためです。 IIS を使用しているのであれば、 [http://trac.edgewall.org/wiki/TracOnWindowsIisAjp AJP] を使うこともできます。 (訳注: Apache でも mod_proxy_ajp 経由で ajp を使用できます。) 
     7 
     8== 単純な Apache の設定 == #SimpleApacheconfiguration 
     9 
     10Apache で利用可能な FastCGI モジュールは 2 種類あります: `mod_fastcgi` と  
     11`mod_fcgid` です。これ以降に書かれている `FastCgiIpcDir` と `FastCgiConfig` ディレクティブ 
     12は `mod_fastcgi` のディレクティブです; `DefaultInitEnv` は `mod_fcgid`  
     13のディレクティブです。 
     14 
     15`mod_fastcgi` では、 Apache の設定ファイルに以下の設定を追記します。 
     16ファイル: 
     17{{{ 
     18# Enable fastcgi for .fcgi files 
     19# (If you're using a distro package for mod_fcgi, something like 
     20# this is probably already present) 
     21<IfModule mod_fastcgi.c> 
     22   AddHandler fastcgi-script .fcgi 
     23   FastCgiIpcDir /var/lib/apache2/fastcgi  
     24</IfModule> 
     25LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so 
     26}}} 
     27デフォルトの設定に問題がなければ、 `FastCgiIpcDir` の設定は必須ではありません。 `LoadModule` の行は `IfModule` グループの後になければいけないことに注意して下さい。 
     28 
     29`ScriptAlias` を設定するもしくは似たオプションが TracCgi で説明されていますが、  
     30`trac.cgi` の代わりに `trac.fcgi` を呼びます。 
     31 
     32`TRAC_ENV` を以下のように設定することができます: 
     33{{{ 
     34FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac 
     35}}} 
     36 
     37もしくは複数の Trac プロジェクトを扱っているときは、このように設定します: 
     38{{{ 
     39FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects 
     40}}} 
     41 
     42これらの設定は、 `mod_fcgid` では動きません。似ていますが  
     43`mod_fcgid` での部分的な解決策は以下の通りになります: 
     44{{{ 
     45DefaultInitEnv TRAC_ENV /path/to/env/trac/ 
     46}}} 
     47しかし、これは `Directory` や `Location` コンテキストで使用することができません。 
     48よって、複数のプロジェクトに対応するのは難しくなります。 
     49 
     50これらのモジュールの両方 (同様に [http://www.lighttpd.net/ lighttpd] と CGI も) で動かすよりよい方法は、  
     51`trac.fcgi` に以下の値を設定することです。  
     52Web サーバに環境変数を設定する必要がなくなります。例: 
     53{{{ 
     54import os 
     55os.environ['TRAC_ENV'] = "/path/to/projectenv" 
     56}}} 
     57or 
     58{{{ 
     59import os 
     60os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" 
     61}}} 
     62 
     63プロジェクトごとの `ScriptAliases` と `.fcgi` スクリプトを設定すれば、 
     64この方法を使用して複数のプロジェクトに対応することができます。  
     65`trac.fcgi` をコピーして、ファイル名を適切に変更し、上記のコードをそれぞれのスクリプトに追記します。 
     66 
     67この [https://coderanger.net/~coderanger/httpd/fcgi_example.conf fcgid 設定例] を見たところ、 !ScriptAlias ディレクティブでは末尾の / も含めて、このように設定する: 
     68{{{ 
     69ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/ 
     70}}} 
     71 
     72== Simple Cherokee Configuration == 
     73 
     74The configuration on Cherokee's side is quite simple. You will only need to know that you can spawn Trac as an SCGI process. 
     75You can either start it manually, or better yet, automatically by letting Cherokee spawn the server whenever it is down. 
     76First set up an information source in cherokee-admin with a local interpreter. 
     77 
     78{{{ 
     79Host: 
     80localhost:4433 
     81 
     82Interpreter: 
     83/usr/bin/tracd —single-env —daemonize —protocol=scgi —hostname=localhost —port=4433 /path/to/project/ 
     84}}} 
     85 
     86If the port was not reachable, the interpreter command would be launched. Note that, in the definition of the information source, you will have to manually launch the spawner if you use a ''Remote host'' as ''Information source'' instead of a ''Local interpreter''. 
     87 
     88After doing this, we will just have to create a new rule managed by the SCGI handler to access Trac. It can be created in a new virtual server, trac.example.net for instance, and will only need two rules. The '''default''' one will use the SCGI handler associated to the previously created information source. 
     89The second rule will be there to serve the few static files needed to correctly display the Trac interface. Create it as ''Directory rule'' for ''/chrome/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''/usr/share/trac/htdocs/'' 
     90 
     91== 単純な Lighttpd の設定 == #SimpleLighttpdConfiguration 
     92 
     93FastCGI フロントエンドは最初 [http://www.lighttpd.net/ lighttpd] のような、 Apache 以外の Web サーバのために開発されました。 
     94 
     95lighttpd はセキュアで高速で、規格に準拠したとても柔軟な Web サーバで、高いパフォーマンスの環境で最適化されます。 
     96他の Web サーバに比べて CPU や、メモリの占有率がとても少ないです。 
     97 
     98`trac.fcgi` (0.11 より前) もしくは fcgi_frontend.py (0.11) を lighttpd で使用するためには、 lighttpd.conf に以下の行を追加します: 
     99{{{ 
     100#var.fcgi_binary="/path/to/fcgi_frontend.py" # 0.11 if installed with easy_setup, it is inside the egg directory 
     101var.fcgi_binary="/path/to/cgi-bin/trac.fcgi" # 0.10 name of prior fcgi executable 
     102fastcgi.server = ("/trac" => 
     103    
     104                   ("trac" => 
     105                     ("socket" => "/tmp/trac-fastcgi.sock", 
     106                      "bin-path" => fcgi_binary, 
     107                      "check-local" => "disable", 
     108                      "bin-environment" => 
     109                        ("TRAC_ENV" => "/path/to/projenv") 
     110                     ) 
     111                   ) 
     112                 ) 
     113}}} 
     114 
     115動かしたい Trac のインスタンス毎に `fastcgi.server` のエントリを追加する必要があります。別の方法として、、上記の `TRAC_ENV` の代わりに `TRAC_ENV_PARENT_DIR` を使用でき、  
     116`lighttpd.conf` に設定する代わりに `trac.fcgi` ファイルに  
     117`bin-environment` (上記の Apache の設定 に書かれています) の2つのうちのどちらかを設定します。 
     118 
     119lighttpd で2つのプロジェクトを動かすには、 `lighttpd.conf` に以下の設定を追加します: 
     120{{{ 
     121fastcgi.server = ("/first" => 
     122                   ("first" => 
     123                    ("socket" => "/tmp/trac-fastcgi-first.sock", 
     124                     "bin-path" => fcgi_binary, 
     125                     "check-local" => "disable", 
     126                     "bin-environment" => 
     127                       ("TRAC_ENV" => "/path/to/projenv-first") 
     128                    ) 
     129                  ), 
     130                  "/second" => 
     131                    ("second" => 
     132                    ("socket" => "/tmp/trac-fastcgi-second.sock", 
     133                     "bin-path" => fcgi_binary, 
     134                     "check-local" => "disable", 
     135                     "bin-environment" => 
     136                       ("TRAC_ENV" => "/path/to/projenv-second") 
     137                    ) 
     138                  ) 
     139                ) 
     140}}} 
     141各フィールドの値が異なることに注意して下さい。もし `.fcgi` スクリプトに 
     142環境変数を設定するほうが好ましい場合は、 `trac.fcgi` をコピー/名前変更をして下さい。例として、 
     143`first.fcgi` と `second.fcgi` が上記の設定では参照されるようにします。 
     144上記の設定で、両方のプロジェクトが 同じ `trac.fcgi` スクリプトで起動していても、 
     145異なるプロセスになることに注意して下さい。 
     146{{{ 
     147#!div class=important 
     148'''Note''' server.modules をロードする順番はとても重要です。 mod_auth が mod_fastcgi より '''先に''' ロードされる設定になっていない場合、サーバはユーザの認証に失敗します。 
     149}}} 
     150認証のために lighttpd.conf の 'server.modules' 中で mod_auth を有効にして、 auth.backend と認証方法を選択して下さい: 
     151{{{ 
     152server.modules              = ( 
     153... 
     154  "mod_auth", 
     155... 
     156) 
     157 
     158auth.backend               = "htpasswd" 
     159 
     160# Separated password files for each project 
     161# See "Conditional Configuration" in 
     162# http://trac.lighttpd.net/trac/file/branches/lighttpd-merge-1.4.x/doc/configuration.txt 
     163 
     164$HTTP["url"] =~ "^/first/" { 
     165  auth.backend.htpasswd.userfile = "/path/to/projenv-first/htpasswd.htaccess" 
     166} 
     167$HTTP["url"] =~ "^/second/" { 
     168  auth.backend.htpasswd.userfile = "/path/to/projenv-second/htpasswd.htaccess" 
     169} 
     170 
     171# Enable auth on trac URLs, see 
     172# http://trac.lighttpd.net/trac/file/branches/lighttpd-merge-1.4.x/doc/authentication.txt 
     173 
     174auth.require = ("/first/login" => 
     175                ("method"  => "basic", 
     176                 "realm"   => "First project", 
     177                 "require" => "valid-user" 
     178                ), 
     179                "/second/login" => 
     180                ("method"  => "basic", 
     181                 "realm"   => "Second project", 
     182                 "require" => "valid-user" 
     183                ) 
     184               ) 
     185 
     186 
     187}}} 
     188パスワードファイルがない場合、 lighttpd (確認したバージョンは 1.4.3) が停止するので注意して下さい。 
     189 
     190バージョン 1.3.16 以前では lighttpd は 'valid-user' をサポートしていないので注意してください。 
     191 
     192条件付の設定は静的リソースをマッピングするときに便利です。例として FastCGI を経由せずに直接イメージファイルや CSS を参照するときなどです。: 
     193{{{ 
     194# Aliasing functionality is needed 
     195server.modules += ("mod_alias") 
     196 
     197# Setup an alias for the static resources 
     198alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs") 
     199 
     200# Use negative lookahead, matching all requests that ask for any resource under /trac, EXCEPT in 
     201# /trac/chrome/common, and use FastCGI for those 
     202$HTTP["url"] =~ "^/trac(?!/chrome/common)" { 
     203# Even if you have other fastcgi.server declarations for applications other than Trac, do NOT use += here 
     204fastcgi.server = ("/trac" => 
     205                   ("trac" => 
     206                     ("socket" => "/tmp/trac-fastcgi.sock", 
     207                      "bin-path" => fcgi_binary, 
     208                      "check-local" => "disable", 
     209                      "bin-environment" => 
     210                        ("TRAC_ENV" => "/path/to/projenv") 
     211                     ) 
     212                   ) 
     213                 ) 
     214} 
     215}}} 
     216複数のプロジェクトのそれぞれにエイリアスを作れば、複数のプロジェクトを動かすのは技術的には簡単です。 fastcgi.server を条件ブロックの中で宣言しラッピングします。 
     217複数のプロジェクトをハンドルするもう一つの方法があります。 TRAC_ENV_PARENT_DIR を TRAC_ENV の代わりに使用し、グローバルの認証機構を使用します。サンプルを見てみましょう: 
     218{{{ 
     219#  This is for handling multiple projects 
     220  alias.url       = ( "/trac/" => "/path/to/trac/htdocs/" ) 
     221 
     222  fastcgi.server += ("/projects"  => 
     223                      ("trac" => 
     224                        ( 
     225                          "socket" => "/tmp/trac.sock", 
     226                          "bin-path" => fcgi_binary, 
     227                          "check-local" => "disable", 
     228                          "bin-environment" => 
     229                            ("TRAC_ENV_PARENT_DIR" => "/path/to/parent/dir/of/projects/" ) 
     230                        ) 
     231                      ) 
     232                    ) 
     233#And here starts the global auth configuration 
     234  auth.backend = "htpasswd" 
     235  auth.backend.htpasswd.userfile = "/path/to/unique/htpassword/file/trac.htpasswd" 
     236  $HTTP["url"] =~ "^/projects/.*/login$" { 
     237    auth.require = ("/" => 
     238                     ( 
     239                       "method"  => "basic", 
     240                       "realm"   => "trac", 
     241                       "require" => "valid-user" 
     242                     ) 
     243                   ) 
     244  } 
     245}}} 
     246 
     247lighttpd では環境変数の LC_TIME を上書きして、日付/時間のフォーマットを変更することも出来ます。 
     248{{{ 
     249fastcgi.server = ("/trac" => 
     250                   ("trac" => 
     251                     ("socket" => "/tmp/trac-fastcgi.sock", 
     252                      "bin-path" => fcgi_binary, 
     253                      "check-local" => "disable", 
     254                      "bin-environment" => 
     255                        ("TRAC_ENV" => "/path/to/projenv", 
     256                        "LC_TIME" => "ru_RU") 
     257                     ) 
     258                   ) 
     259                 ) 
     260}}} 
     261使用言語指定の詳細については [http://trac.lighttpd.net/trac/wiki/TracFaq TracFaq] の 2.13 の質問を参照して下さい。 
     262 
     263その他重要な情報、例えば、 [http://trac.lighttpd.net/trac/wiki/TracInstall lighttpd の TracInstall] や、 [wiki:TracCgi#静的なリソースをマッピングする TracCgi] などは fast-cgi 固有ではありませんが、インストールの詳細をつかむのに有用でしょう。 
     264 
     265trac-0.9 を使用している場合、[http://lists.edgewall.com/archive/trac/2005-November/005311.html 些細なバグ] について読んでください。 
     266 
     267lighttpd を再起動し、ブラウザに `http://yourhost.example.org/trac` を入力して、 Trac にアクセスして下さい。 
     268 
     269制限された権限で lighttpd を起動するにあたって気をつけること: 
     270 
     271  もし、 trac.fcgi が lighttpd の設定で __server.username = "www-data"__ や __server.groupname = "www-data"__ を設定しても起動せずどうしようもないときは、 `bin-environment` セクションの `PYTHON_EGG_CACHE` を `www-data` のホームディレクトリまたは `www-data` アカウントで書き込みが可能なディレクトリに設定して下さい。 (訳注: debian 系 Linux に限定した話だと思われます。 `www-data` は lighttpd を起動するユーザに適宜読み替えてください。) 
     272 
     273 
     274== 簡単な !LiteSpeeed の設定 == #SimpleLiteSpeedConfiguration 
     275 
     276FastCGI フロントエンドは [http://www.litespeedtech.com/ LiteSpeed] のような、 Apache 以外の Web サーバのために開発されました。 
     277 
     278!LiteSpeed Web サーバはイベント駆動、非同期型であり、Apache に代わるものとしてセキュアで拡張可能になるようにゼロからデザインされています。そして、最低限のリソースで操作できます。 !LiteSpeed は Apache の設定ファイルから直接操作でき、ビジネスに不可欠な環境をターゲットにしています。 
     279 
     280セットアップ 
     281 
     2821) 最初に Trac プロジェクトをインストールして動作することを確認して下さい。最初のインストールでは、 "tracd" を使用します。 
     283 
     2842) このセットアップでは仮想ホストを作成します。以下、この仮想ホストのことを !TracVhost と呼びます。このチュートリアルで、先ほど作ったプロジェクトが以下の URL 経由でアクセスできると仮定します: 
     285 
     286{{{ 
     287http://yourdomain.com/trac/ 
     288}}} 
     289 
     2903) "!TracVhost → External AApps" タブへ移動し、新しい "External Application" を作成します。 
     291 
     292{{{ 
     293Name: MyTracFCGI         
     294Address: uds://tmp/lshttpd/mytracfcgi.sock 
     295Max Connections: 10 
     296Environment: TRAC_ENV=/fullpathto/mytracproject/ <--- path to root folder of trac project 
     297Initial Request Timeout (secs): 30 
     298Retry Timeout (secs): 0 
     299Persistent Connection   Yes 
     300Connection Keepalive Timeout: 30 
     301Response Bufferring: No  
     302Auto Start: Yes 
     303Command: /usr/share/trac/cgi-bin/trac.fcgi  <--- path to trac.fcgi 
     304Back Log: 50 
     305Instances: 10 
     306}}} 
     307 
     3084) (非必須) "!TracVhost → Security" タブへ移動し、新しいセキュリティ "Realm" を作成することができます。 
     309 
     310{{{ 
     311DB Type: Password File 
     312Realm Name: MyTracUserDB               <--- any name you wish and referenced later 
     313User DB Location: /fullpathto/htpasswd <--- path to your htpasswd file 
     314}}} 
     315 
     316もし、 htpasswd ファイルを持っていない、もしくは作り方を知らない場合は、 http://sherylcanter.com/encrypt.php にアクセスし、ユーザ名:パスワード の一対を生成して下さい。 
     317 
     3185) "!PythonVhost → Contexts" へ移動し、新しい "FCGI Context" を作成します。 
     319 
     320{{{ 
     321URI: /trac/                              <--- URI path to bind to python fcgi app we created     
     322Fast CGI App: [VHost Level] MyTractFCGI  <--- select the trac fcgi extapp we just created 
     323Realm: TracUserDB                        <--- only if (4) is set. select realm created in (4) 
     324}}} 
     325 
     3266) /fullpathto/mytracproject/conf/trac.ini を修正します。 
     327 
     328{{{ 
     329#find/set base_rul, url, and link variables 
     330base_url = http://yourdomain.com/trac/ <--- base url to generate correct links to 
     331url = http://yourdomain.com/trac/      <--- link of project 
     332link = http://yourdomain.com/trac/     <--- link of graphic logo 
     333}}} 
     334 
     3357) !LiteSpeed を "lswsctrl restart" で再起動し、新しい Trac プロジェクトに以下の URL でアクセスします: 
     336 
     337 
     338{{{ 
     339http://yourdomain.com/trac/ 
     340}}} 
     341 
     342=== Simple Nginx Configuration === 
     343 
     3441) Nginx configuration snippet - confirmed to work on 0.6.32 
     345{{{ 
     346    server { 
     347        listen       10.9.8.7:443; 
     348        server_name  trac.example; 
     349 
     350        ssl                  on; 
     351        ssl_certificate      /etc/ssl/trac.example.crt; 
     352        ssl_certificate_key  /etc/ssl/trac.example.key; 
     353 
     354        ssl_session_timeout  5m; 
     355 
     356        ssl_protocols  SSLv2 SSLv3 TLSv1; 
     357        ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP; 
     358        ssl_prefer_server_ciphers   on; 
     359 
     360        # (Or ``^/some/prefix/(.*)``. 
     361        if ($uri ~ ^/(.*)) { 
     362             set $path_info /$1; 
     363        } 
     364 
     365        # You can copy this whole location to ``location [/some/prefix]/login`` 
     366        # and remove the auth entries below if you want Trac to enforce 
     367        # authorization where appropriate instead of needing to authenticate 
     368        # for accessing the whole site. 
     369        # (Or ``location /some/prefix``.) 
     370        location / { 
     371            auth_basic            "trac realm"; 
     372            auth_basic_user_file /home/trac/htpasswd; 
     373 
     374            # socket address 
     375            fastcgi_pass   unix:/home/trac/run/instance.sock; 
     376 
     377            # python - wsgi specific 
     378            fastcgi_param HTTPS on; 
     379 
     380            ## WSGI REQUIRED VARIABLES 
     381            # WSGI application name - trac instance prefix. 
     382            # (Or ``fastcgi_param  SCRIPT_NAME  /some/prefix``.) 
     383            fastcgi_param  SCRIPT_NAME        ""; 
     384            fastcgi_param  PATH_INFO          $path_info; 
     385 
     386            ## WSGI NEEDED VARIABLES - trac warns about them 
     387            fastcgi_param  REQUEST_METHOD     $request_method; 
     388            fastcgi_param  SERVER_NAME        $server_name; 
     389            fastcgi_param  SERVER_PORT        $server_port; 
     390            fastcgi_param  SERVER_PROTOCOL    $server_protocol; 
     391 
     392            # for authentication to work 
     393            fastcgi_param  AUTH_USER          $remote_user; 
     394            fastcgi_param  REMOTE_USER        $remote_user; 
     395        } 
     396    } 
     397}}} 
     398 
     3992) Modified trac.fcgi: 
     400 
     401{{{ 
     402#!/usr/bin/env python 
     403import os 
     404sockaddr = '/home/trac/run/instance.sock' 
     405os.environ['TRAC_ENV'] = '/home/trac/instance' 
     406 
     407try: 
     408     from trac.web.main import dispatch_request 
     409     import trac.web._fcgi 
     410 
     411     fcgiserv = trac.web._fcgi.WSGIServer(dispatch_request,  
     412          bindAddress = sockaddr, umask = 7) 
     413     fcgiserv.run() 
     414 
     415except SystemExit: 
     416    raise 
     417except Exception, e: 
     418    print 'Content-Type: text/plain\r\n\r\n', 
     419    print 'Oops...' 
     420    print 
     421    print 'Trac detected an internal error:' 
     422    print 
     423    print e 
     424    print 
     425    import traceback 
     426    import StringIO 
     427    tb = StringIO.StringIO() 
     428    traceback.print_exc(file=tb) 
     429    print tb.getvalue() 
     430 
     431}}} 
     432 
     4333) reload nginx and launch trac.fcgi like that: 
     434 
     435{{{ 
     436trac@trac.example ~ $ ./trac-standalone-fcgi.py  
     437}}} 
     438 
     439The above assumes that: 
     440 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory. 
     441 * /home/trac/instance contains a trac environment 
     442 * /home/trac/htpasswd contains authentication information 
     443 * /home/trac/run is owned by the same group the nginx runs under 
     444  * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run) 
     445  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time 
     446 
     447Unfortunately nginx does not support variable expansion in fastcgi_pass directive.  
     448Thus it is not possible to serve multiple trac instances from one server block.  
     449 
     450If you worry enough about security, run trac instances under separate users.  
     451 
     452Another way to run trac as a FCGI external application is offered in ticket #T6224 
     453 
     454---- 
     455See also:  TracGuide, TracInstall, [wiki:TracModWSGI ModWSGI], [wiki:TracCgi CGI], [wiki:TracModPython ModPython], [http://trac.edgewall.org/wiki/TracNginxRecipe TracNginxRecipe]