Changes between Version 1 and Version 2 of TracCgi


Ignore:
Timestamp:
12/14/10 02:51:48 (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracCgi

    v1 v2  
    1 = CGIとして Trac をインストールする = 
     1= Installing Trac as CGI = 
    22 
    3 Trac を CGI スクリプトとしてインストールするために、 Web サーバが `trac.cgi` を CGI として実行できるようにする必要があります。使用している Web サーバが [http://httpd.apache.org/ Apache HTTPD] であれば、2つの方法があります: 
     3{{{ 
     4#!div class=important 
     5  ''Please note that using Trac via CGI is the slowest deployment method available. It is slower than [TracModPython mod_python], [TracFastCgi FastCGI] and even [trac:TracOnWindowsIisAjp IIS/AJP] on Windows.'' 
     6}}} 
    47 
    5  1. `ScriptAlias` を使用し、 `trac.cgi` スクリプトを URL にマップする。 
    6  2. CGI プログラムが実行可能な、Web サーバ上のディレクトリ (通常は `cgi-bin` が使用される) に `trac.cgi` ファイルをコピーする。シンボリックリンクでも代用できますが、その場合 `cgi-bin` ディレクトリでは `FollowSymLinks` オプションを有効にして下さい。 
     8CGI script is the entrypoint that web-server calls when a web-request to an application is made. To generate the `trac.cgi` script run: 
     9{{{ 
     10trac-admin /path/to/env deploy /path/to/www/trac 
     11}}} 
     12`trac.cgi` will be in the `cgi-bin` folder inside the given path. Make sure it is executable by your web server. This command also copies `static resource` files to a `htdocs` directory of a given destination. 
    713 
    8 CGI を分かりやすい URL にマッピングできるので、 1 番目のオプションを推奨します。 
     14== Apache web-server configuration == 
    915 
    10 それでは、 Apache の設定ファイルに以下のブロックを追記し、ファイル名とロケーションを変更してください: 
     16In [http://httpd.apache.org/ Apache] there are two ways to run Trac as CGI: 
     17 
     18 1. Use a `ScriptAlias` directive that maps an URL to the `trac.cgi` script (recommended) 
     19 2. Copy the `trac.cgi` file into the directory for CGI executables used by your web server (commonly named `cgi-bin`). You can also create a symbolic link, but in that case make sure that the `FollowSymLinks` option is enabled for the `cgi-bin` directory. 
     20 
     21To make Trac available at `http://yourhost.example.org/trac` add `ScriptAlias` directive to Apache configuration file, changing `trac.cgi` path to match your installation: 
    1122{{{ 
    12 ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi 
     23ScriptAlias /trac /path/to/www/trac/cgi-bin/trac.cgi 
     24}}} 
    1325 
    14 # Trac needs to know where the database is located 
     26 ''Note that this directive requires enabled `mod_alias` module.'' 
     27 
     28If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable: 
     29{{{ 
    1530<Location "/trac"> 
    1631  SetEnv TRAC_ENV "/path/to/projectenv" 
    … …  
    1833}}} 
    1934 
    20 `http://yourhost.example.org/trac` のような URL で Trac が使用できるようになります。 
     35Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable: 
     36{{{ 
     37<Location "/trac"> 
     38  SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir" 
     39</Location> 
     40}}} 
    2141 
    22  ''Note: 上記の設定で Apache がエラーを出力する場合、 `mod_alias` と `mod_env` モジュールが有効な状態になっていることを確認して下さい。'' 
     42 ''Note that the `SetEnv` directive requires enabled `mod_env` module. It is also possible to set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web ...":'' 
    2343 
    24  ''Note: [http://httpd.apache.org/docs/suexec.html Apache suEXEC] 機能を使用している場合、 [http://projects.edgewall.com/trac/wiki/ApacheSuexec ApacheSuexec] を参照して下さい。'' 
     44{{{ 
     45    import os 
     46    os.environ['TRAC_ENV'] = "/path/to/projectenv" 
     47}}} 
    2548 
    26 == 静的なリソースをマッピングする == 
     49 '' Or for TRAC_ENV_PARENT_DIR: '' 
    2750 
    28 このままでも Trac はスタイルシートや画像ファイルなどの静的なリソースを扱えますが、 CGI のセットアップとしては妥当な設定とは言えません。 Web サーバ自身がより効率良くに扱うことができるドキュメントまで、 CGI スクリプトとして呼び出してしまうという結果になるからです。 
     51{{{ 
     52    import os 
     53    os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir" 
     54}}} 
    2955 
    30 [http://httpd.apache.org/ Apache HTTPD] のような Web サーバはリソースに対して "Alias" を設定することで仮想の URL を与え、サーバのファイルシステムのレイアウトとは異なる位置にマップすることができます。すでに CGI スクリプトに対して `ScriptAlias` を定義していますので、ファイルシステム上の静的リソースを含んだコンテンツをマッピングすることで CGI スクリプトの要求を回避します。 
     56If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec]. 
    3157 
    32 Apacheの設定ファイルを再び編集して、 CGI スクリプトの `ScriptAlias` を追記したブロックより '''上に''' 以下のブロックを追記します。ファイル名とロケーションは適宜変更してください: 
     58On some systems, you ''may'' need to edit the shebang line in the `trac.cgi` file to point to your real Python installation path. On a Windows system you may need to configure Windows to know how to execute a .cgi file (Explorer -> Tools -> Folder Options -> File Types -> CGI). 
     59 
     60== Mapping Static Resources == 
     61 
     62Out of the box, Trac will pass static resources such as style sheets or images through itself. For a CGI setup this is '''highly undesirable''', because this way CGI script is invoked for documents that could be much more efficiently served directly by web server. 
     63 
     64Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We already used this capability by defining a `ScriptAlias` for the CGI script. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by CGI script. 
     65 
     66There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources usually accessible by `/chrome/plugin` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything. 
     67 
     68Add the following snippet to Apache configuration '''before''' the `ScriptAlias` for the CGI script, changing paths to match your deployment: 
    3369{{{ 
    34 Alias /trac/chrome/common /usr/share/trac/htdocs 
    35 <Directory "/usr/share/trac/htdocs"> 
     70Alias /trac/chrome/common /path/to/trac/htdocs/common 
     71Alias /trac/chrome/site /path/to/trac/htdocs/site 
     72<Directory "/path/to/www/trac/htdocs"> 
    3673  Order allow,deny 
    3774  Allow from all 
    … …  
    3976}}} 
    4077 
    41 `trac.cgi` スクリプトにどんな URL をマッピングしたとしても、 `/chrome/common` というパスでは静的リソースのロケーションを使用するようになります。 
     78If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 
     79{{{ 
     80<Location "/trac/chrome/common/"> 
     81  SetHandler None 
     82</Location> 
     83}}} 
    4284 
    43 例えば、Trac が `/cgi-bin/trac.cgi`にマッピングされているとしたら、AliasのURLは `cgi-bin/trac.cgi/chrome/common` となります。 
     85Note that we mapped `/trac` part of the URL to the `trac.cgi` script, and the path `/chrome/common` is the path you have to append to that location to intercept requests to the static resources.  
    4486 
    45 代わりに、[wiki:TracIni trac.ini] のオプションで `htdocs_location` を設定することができます: 
     87For example, if Trac is mapped to `/cgi-bin/trac.cgi` on your server, the URL of the Alias should be `/cgi-bin/trac.cgi/chrome/common`. 
     88 
     89Similarly, if you have static resources in a project's htdocs directory (which is referenced by /chrome/site URL in themes), you can configure Apache to serve those resources (again, put this '''before''' the `ScriptAlias` for the CGI script, and adjust names and locations to match your installation): 
     90 
     91{{{ 
     92Alias /trac/chrome/site /path/to/projectenv/htdocs 
     93<Directory "/path/to/projectenv/htdocs"> 
     94  Order allow,deny 
     95  Allow from all 
     96</Directory> 
     97}}} 
     98 
     99Alternatively to hacking `/trac/chrome/site`, you can directly specify path to static resources using `htdocs_location` configuration option in [wiki:TracIni trac.ini]: 
    46100{{{ 
    47101[trac] 
    48 htdocs_location = /trac-htdocs 
     102htdocs_location = http://yourhost.example.org/trac-htdocs 
    49103}}} 
    50104 
    51 Trac は HTML ページに静的リソースを組み込むときに、この URL を使用するようになります。もちろん、それでも、特定の URL が指定されたときに 例えば、 Web サーバーのドキュメントルートにディレクトリをコピーするなり、シンボリックリンクを張るなりして、Web サーバ経由で、 Trac が `htdocs` ディレクトリを利用できるようにしておく必要があります。 
     105Trac will then use this URL when embedding static resources into HTML pages. Of course, you still need to make the Trac `htdocs` 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: 
     106{{{ 
     107$ ln -s /path/to/www/trac/htdocs /var/www/yourhost.example.org/trac-htdocs 
     108}}} 
    52109 
    53 == 認証を追加する == 
     110Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `deploy` command of TracAdmin: 
     111[[TracAdminHelp(deploy)]] 
    54112 
    55 Apache で認証を追加する最も単純な方法はパスワードファイルを作ることです。 `htpasswd` プログラムを使用してパスワードファイルを作成します: 
     113 
     114== Adding Authentication == 
     115 
     116The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program to create the password file: 
    56117{{{ 
    57118$ htpasswd -c /somewhere/trac.htpasswd admin 
    … …  
    61122}}} 
    62123 
    63 一番最初のユーザ以外は "-c" オプションは必要ありません: 
     124After the first user, you dont need the "-c" option anymore: 
    64125{{{ 
    65126$ htpasswd /somewhere/trac.htpasswd john 
    … …  
    69130}}} 
    70131 
    71   ''`htpasswd` についての詳細は man を見てください。'' 
     132  ''See the man page for `htpasswd` for full documentation.'' 
    72133 
    73 ユーザを作成した後、 TracPermissions の記述通りユーザに権限を設定することができます。 
     134After you've created the users, you can set their permissions using TracPermissions. 
    74135 
    75 Apache の設定ファイルの中にパスワードファイル名を記述し、認証を有効にする必要があります: 
     136Now, you'll need to enable authentication against the password file in the Apache configuration: 
    76137{{{ 
    77 <Location "/cgi-bin/trac.cgi/login"> 
     138<Location "/trac/login"> 
    78139  AuthType Basic 
    79140  AuthName "Trac" 
    … …  
    83144}}} 
    84145 
    85 より堅固なセキュリティのために、 SSL を有効にするか、少なくとも "基本認証" の代わりに "ダイジェスト認証" を使用することを推奨します。より詳しい情報については [http://httpd.apache.org/docs/2.0/ Apache HTTPD documentation] を参照して下さい。 
     146If you're hosting multiple projects you can use the same password file for all of them: 
     147{{{ 
     148<LocationMatch "/trac/[^/]+/login"> 
     149  AuthType Basic 
     150  AuthName "Trac" 
     151  AuthUserFile /somewhere/trac.htpasswd 
     152  Require valid-user 
     153</LocationMatch> 
     154}}} 
     155 
     156For better security, it is recommended that you either enable SSL or at least use the “digest” authentication scheme instead of “Basic”. Please read the [http://httpd.apache.org/docs/2.0/ Apache HTTPD documentation] to find out more. For example, on a Debian 4.0r1 (etch) system the relevant section  in apache configuration can look like this: 
     157{{{ 
     158<Location "/trac/login"> 
     159    LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so 
     160    AuthType Digest 
     161    AuthName "trac" 
     162    AuthDigestDomain /trac 
     163    AuthUserFile /somewhere/trac.htpasswd 
     164    Require valid-user 
     165</Location> 
     166}}} 
     167and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows: 
     168{{{ 
     169# htdigest /somewhere/trac.htpasswd trac admin 
     170}}} 
     171where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs).  
    86172 
    87173---- 
    88 See also:  TracGuide, TracInstall, TracFastCgi, TracModPython 
     174See also:  TracGuide, TracInstall, [wiki:TracModWSGI], TracFastCgi, TracModPython