XPressME Integration Kit

Trac

Version 1 から Version 2 における更新: TracStandalone

差分発生行の前後
Ignore:
Timestamp:
Nov 29, 2010, 3:25:29 PM (10 years 前)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v2  
    11= Tracd = 
    22 
    3 Tracd は軽量なスタンドアロンの Trac Web サーバです。ほとんどのケースでは [wiki:TracCgi CGI] よりセットアップが簡単で、処理速度も速くなります。 
    4  
    5 == 利点 == #Pros 
    6  
    7  * 依存性が低い: Apache その他 Web サーバをインストールする必要がありません。 
    8  * 速い: [wiki:TracModPython mod_python] バージョンと同じくらい速いでしょう。 ([wiki:TracCgi CGI] よりはずっと速い)。 
    9  * 自動リロード: 開発のために、 Tracd は ''auto_reload'' モードを使用しています。そのため、コード (Trac 自身またはプラグインのコード) を更新したときに、自動的にサーバが再起動します。 
    10  
    11 == 欠点 == #Cons 
    12  
    13  * 機能が少ない: Tracd に実装されている Web サーバはとてもシンプルで、 Apache HTTPD のように拡張性のある設定ができません。 
    14  * ネイティブで HTTPS に対応しない: 代わりに [http://www.rickk.com/sslwrap/ sslwrap] または 
    15    [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- tracd と stunnel を使うためのチュートリアル] または Apache の mod_proxy を使用します。 
    16  
    17 == 使用例 == #Usageexamples 
    18  
    19 単一のプロジェクトをポート 8080 でホストします。 (http://localhost:8080/) 
     3Tracd is a lightweight standalone Trac web server. 
     4It can be used in a variety of situations, from a test or development server to a multiprocess setup behind another web server used as a load balancer. 
     5 
     6== Pros == 
     7 
     8 * Fewer dependencies: You don't need to install apache or any other web-server. 
     9 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]), even more so since version 0.12 where the HTTP/1.1 version of the protocol is enabled by default 
     10 * Automatic reloading: For development, Tracd can be used in ''auto_reload'' mode, which will automatically restart the server whenever you make a change to the code (in Trac itself or in a plugin). 
     11 
     12== Cons == 
     13 
     14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd. 
     15 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 
     16   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. 
     17 
     18== Usage examples == 
     19 
     20A single project on port 8080. (http://localhost:8080/) 
    2021{{{ 
    2122 $ tracd -p 8080 /path/to/project 
    2223}}} 
    23 厳密に言うと、この状態では Trac は ''localhost のみ'' ではなく、ネットワーク越しの全員からアクセス可能になっています。 ''--hostname'' オプションを使用すると接続元を制限できます。 
     24Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option. 
    2425{{{ 
    2526 $ tracd --hostname=localhost -p 8080 /path/to/project 
    2627}}} 
    27 複数のプロジェクトをホストする場合はこうです (http://localhost:8080/project1/ と http://localhost:8080/project2/) 
     28With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 
    2829{{{ 
    2930 $ tracd -p 8080 /path/to/project1 /path/to/project2 
    3031}}} 
    3132 
    32 Trac は異なるプロジェクト間での URL の一意性を保つために、パスの一番最後の文字列 (訳注: basename) を使用するため、プロジェクト間でパスの一番最後の部分を同じにすることは出来ません。 
    33 もし、 `/project1/path/to` と `/project2/path/to` を同時に指定した場合、二つ目のプロジェクトだけしか見えなくなります。 
    34  
    35 複数のプロジェクトを動かすもう一つの方法は、 `-e` オプションで親ディレクトリを指定し、サブディレクトリに TracEnvironment を配置します。上記の例は以下のように書き換えられます: 
     33You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the 
     34different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project. 
     35 
     36An alternative way to serve multiple projects is to specify a parent directory in which each subdirectory is a Trac project, using the `-e` option. The example above could be rewritten: 
    3637{{{ 
    3738 $ tracd -p 8080 -e /path/to 
    3839}}} 
    3940 
    40 Windows でサーバを終了するには必ず {{{CTRL-BREAK}}} を使用してください。 -- {{{CTRL-C}}} を使用すると Python のプロセスがバックグラウンドで起動したままになるでしょう。 
    41  
    42  
    43 == 認証を使用する == #UsingAuthentication 
     41To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background. 
     42 
     43== Installing as a Windows Service == 
     44 
     45=== Option 1 === 
     46To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run: 
     47{{{ 
     48 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe 
     49 reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\tracd-script.py\" <your tracd parameters>" 
     50 net start tracd 
     51}}} 
     52 
     53'''DO NOT''' use {{{tracd.exe}}}.  Instead register {{{python.exe}}} directly with {{{tracd-script.py}}} as a parameter.  If you use {{{tracd.exe}}}, it will spawn the python process without SRVANY's knowledge.  This python process will survive a {{{net stop tracd}}}. 
     54 
     55If you want tracd to start automatically when you boot Windows, do: 
     56{{{ 
     57 sc config tracd start= auto 
     58}}} 
     59 
     60The spacing here is important. 
     61 
     62For Windows 7 User, srvany.exe may not be an option, so you can use [http://www.google.com/search?q=winserv.exe WINSERV] utility and run: 
     63{{{ 
     64"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd-script.py <your tracd parameters>" 
     65 
     66net start tracd 
     67}}} 
     68 
     69=== Option 2 === 
     70 
     71Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 
     72 
     73== Using Authentication == 
    4474 
    4575Using tracd with Apache .htpasswd files: 
     
    4878 
    4979{{{ 
    50 sudo htpasswd -c /path/to/env/.htpasswd username 
     80 $ htpasswd -c /path/to/env/.htpasswd username 
    5181}}} 
    5282then for additional users: 
    5383{{{ 
    54 sudo htpasswd /var/www/html/.htpasswd-users username2 
    55 }}} 
    56 then for starting the tracd: 
     84 $ htpasswd /path/to/env/.htpasswd username2 
     85}}} 
     86then for starting the tracd (on windows skip the "=" after --basic-auth): 
    5787{{{ 
    5888tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 
    5989}}} 
    6090 
    61  
    62 Tracd は基本認証とダイジェスト認証の両方に対応しています。デフォルトはダイジェスト認証です; 基本認証を使用するためには、以降の例で使用する `--auth` を `--basic-auth` に置き換えて下さい。 (ダイアログに使用する "realm" を指定しなければなりません。 BASICAUTH には カンマ を末尾に指定した空の文字列を指定することができます。) 
    63  
    64   ''基本認証への対応はバージョン 0.9 以降で追加されました。'' 
    65  
    66 認証を使用するための一般的なコマンドは以下の通りです: 
    67  
    68 {{{ 
    69  $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path 
    70 }}} 
    71  
    72 オプションについて: 
    73  
    74  * '''base_project_dir''' はプロジェクトのベースディレクトリ; Note: これはプロジェクト名ではありません。そして Windows の環境においても、大文字と小文字を区別します。 
    75  * '''password_file_path''' パスワードファイルのパス 
    76  * '''realm''' レルム 
    77  * '''project_path''' プロジェクトのパス 
    78  
    79 使用例: 
     91 `environmentname` is the directory name of the Trac project folder, as opposed to `/fullpath/environmentname` which is the full path to the Trac project folder. See below for another example. 
     92 
     93Tracd provides support for both Basic and Digest authentication. The default is to use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the examples below. (You must still specify a dialogic "realm", which can be an empty string by trailing the BASICAUTH with a comma.) 
     94 
     95  ''Support for Basic authentication was added in version 0.9.'' 
     96 
     97The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth): 
     98 
     99{{{ 
     100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 
     101}}} 
     102 
     103where: 
     104 
     105 * '''base_project_dir''': the base directory of the project specified as follows: 
     106   * when serving multiple projects: ''relative'' to the `project_path` 
     107   * when serving only a single project (`-s`): the name of the project directory 
     108 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. 
     109 * '''password_file_path''': path to the password file 
     110 * '''realm''': the realm name (can be anything) 
     111 * '''project_path''': path of the project 
     112 
     113Examples: 
    80114 
    81115{{{ 
    82116 $ tracd -p 8080 \ 
    83    --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 
    84 }}} 
    85 もちろん、ダイジェストファイルは複数のプロジェクト間で共有することが出来ます: 
     117   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 
     118}}} 
     119 
     120Of course, the password file can be be shared so that it is used for more than one project: 
    86121{{{ 
    87122 $ tracd -p 8080 \ 
    88    --auth=project1,/path/to/users.htdigest,mycompany.com \ 
    89    --auth=project2,/path/to/users.htdigest,mycompany.com \ 
     123   --auth="project1,/path/to/passwordfile,mycompany.com" \ 
     124   --auth="project2,/path/to/passwordfile,mycompany.com" \ 
    90125   /path/to/project1 /path/to/project2 
    91126}}} 
    92127 
    93 ダイジェストファイルを共有するもうひとつの方法は、プロジェクトの名前に "*"  
    94 を指定することです: 
     128Another way to share the password file is to specify "*" for the project name: 
    95129{{{ 
    96130 $ tracd -p 8080 \ 
    97    --auth=*,/path/to/users.htdigest,mycompany.com \ 
     131   --auth="*,/path/to/users.htdigest,mycompany.com" \ 
    98132   /path/to/project1 /path/to/project2 
    99133}}} 
    100134 
    101 == htdigest パスワードファイルの設定方法 == #Howtosetupanhtdigestpasswordfile 
    102  
    103 もし、 Apache がインストールされているなら、パスワードファイルを生成するのに、 htdigest コマンドを使用することができます。 'htdigest' とタイプして使用方法を見るか、詳細な使用方法を見るために Apache のマニュアルの [http://httpd.apache.org/docs/2.0/programs/htdigest.html このページ] を読んでください。ユーザを作成するたびに、パスワードを入力するように求められます。パスワードファイルの名前には好きな名前をつけることができますが、 `users.htdigest` というような名前にしておけば、ファイルに何が含まれているかを覚えておけるでしょう。このファイルは <projectname>/conf フォルダに [TracIni trac.ini] ファイルと一緒に置いておくとよいでしょう。 
    104  
    105 引数 --auth なしで tracd をスタートできることに注意して下さい。ただし、 ''ログイン'' (英語版では ''Login'') リンクをクリックするとエラーになります。 
    106  
    107 == Apache 以外の環境でパスワードを生成する == #GeneratingPasswordsWithoutApache 
    108  
    109 もし Apache が使用できない場合でも、簡単な Python スクリプトでパスワードを生成できます: 
     135=== Using a htpasswd password file === 
     136This section describes how to use `tracd` with Apache .htpasswd files. 
     137 
     138To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 
     139 
     140{{{ 
     141 $ sudo htpasswd -c /path/to/env/.htpasswd username 
     142}}} 
     143then for additional users: 
     144{{{ 
     145 $ sudo htpasswd /path/to/env/.htpasswd username2 
     146}}} 
     147 
     148Then to start `tracd` run something like this: 
     149 
     150{{{ 
     151 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 
     152}}} 
     153 
     154For example: 
     155 
     156{{{ 
     157 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 
     158}}} 
     159 
     160''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 
     161 
     162=== Using a htdigest password file === 
     163 
     164If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [http://httpd.apache.org/docs/2.0/programs/htdigest.html this page] from the Apache manual to get precise instructions.  You'll be prompted for a password to enter for each user that you create.  For the name of the password file, you can use whatever you like, but if you use something like `users.htdigest` it will remind you what the file contains. As a suggestion, put it in your <projectname>/conf folder along with the [TracIni trac.ini] file. 
     165 
     166Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
     167 
     168=== Generating Passwords Without Apache === 
     169 
     170If you don't have Apache available, you can use this simple Python script to generate your passwords: 
    110171 
    111172{{{ 
    112173#!python 
    113174from optparse import OptionParser 
    114 import md5 
     175# The md5 module is deprecated in Python 2.5 
     176try: 
     177    from hashlib import md5 
     178except ImportError: 
     179    from md5 import md5 
     180realm = 'trac' 
    115181 
    116182# build the options 
     
    121187parser.add_option("-p", "--password",action="store", dest="password", type = "string", 
    122188                  help="the password to use") 
     189parser.add_option("-r", "--realm",action="store", dest="realm", type = "string", 
     190                  help="the realm in which to create the digest") 
    123191(options, args) = parser.parse_args() 
    124192 
     
    126194if (options.username is None) or (options.password is None): 
    127195   parser.error("You must supply both the username and password") 
     196if (options.realm is not None): 
     197   realm = options.realm 
    128198    
    129199# Generate the string to enter into the htdigest file 
    130 realm = 'trac' 
    131 kd = lambda x: md5.md5(':'.join(x)).hexdigest() 
     200kd = lambda x: md5(':'.join(x)).hexdigest() 
    132201print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 
    133202}}} 
    134203 
    135 Note: もし tracd を --basic-auth ではなくて、 --auth オプションを使用して起動するときに、上記のスクリプトを使わないといけないとしたら --auth の値に 'trac' を(シングルクォートなしで) 指定し、レルムを設定しなければなりません。(上記スクリプトを trac-digest.py として保存したとします) 
    136  
    137 {{{ 
    138 python trac-digest.py -u username -p password >> c:\digest.txt 
    139 tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 
    140 }}} 
    141  
    142 Note: --basic-auth を使用したければ、 .htpasswd ファイルを作成するのに Apache サーバの htpasswd ツールを使用する必要があります。 他の部分についてはダイジェスト認証を行う場合とほとんど同じ方法です。しかしレルムには必ず empty 値 (すなわち、パス後のカンマのみ) を指定するようにしてください。 Windows で使用する場合は必ず -m オプションを使用してください。 (*nix ではテストしなかったので、その場合は不明です) Apache がない環境では、 [http://trac.edgewall.org/browser/tags/trac-0.11b2/contrib/htpasswd.py htpasswd.py] を使うとよいでしょう。 (このスクリプトは `crypt` か `fcrypt` モジュールが必要です; ソースのコメントに詳細が書いてあります。) 
    143  
    144 md5sum ユーティリティを使用するとダイジェストパスワードを作成することができます: 
    145 {{{ 
    146 echo -e "${user}:trac:${password}\c" | md5sum - >>to-file 
    147 }}} 
    148 'to-file' は手で編集が必要です。行末の " -" を削除し、行頭に "${user}:trac:" を追加してください。詳細は [http://trac.edgewall.org/attachment/wiki/TracStandalone/trac-digest-corrected.sh trac-digest-corrected.sh] を参照してください。 (訳注: realm が `trac` に固定されていますので、実際には改造しないと使えないでしょう) 
    149  
    150 == Tips == #Tips 
    151  
    152 === 静的なリソースを扱う === #Servingstaticcontent 
    153  
    154 もし、 `tracd` が単一のプロジェクトのみを扱う Web サーバだとしたら、 
    155 静的なリソースを割り当てるのに使用することができます。 
    156 (tar アーカイブ, Doxygen ドキュメントなど) 
    157  
    158 この静的なリソースは `$TRAC_ENV/htdocs` フォルダに置き、 
    159 `<project_URL>/chrome/site/...` という URL でアクセスします。 
    160  
    161 例: ファイル名が `$TRAC_ENV/htdocs/software-0.1.tar.gz` だったとき、 
    162 対応する URL は `/<project_name>/chrome/site/software-0.1.tar.gz` となります。 
    163 Wiki には、相対リンクシンタックスを使用して、  
    164 `[/<project_name>/chrome/site/software-0.1.tar.gz]` と書くことができます。 (訳注: `[/chrome/site/software-0.1.tar.gz]` が正しい) 
    165  
    166 Trac の開発バージョンでは新しく `htdocs:` に対応します。 TracLinks は 
    167 上記のようなシンタックスになります。これによって、上記の例のリンクはただ単に  
    168 `htdocs:software-0.1.tar.gz` と書くことができます。 
    169  
    170 === Apache の書き換え規則を使用する === #Usingapacherewriterules 
    171 Apache のビハインドで tracd を使用すると、いくつかの状況で不正なホストまたはプロトコルに URL をリダイレクトされる問題が発生するかもしれません。この場合 (この場合だけ) `[trac] use_base_url_for_redirect` を `true` に設定することができます。これによって Trac がやむを得ず `[trac] base_url` の値を使用するためリダイレクトを行います。 
    172  
    173 === 検索パスとは別のベースパス (/) === #Servingadifferentbasepaththan 
    174 Tracd は、プロジェクト毎に異なるベース URL 、および /<project> をサポートします。コマンドは以下の通りです。 
    175 {{{ 
    176 tracd --base-path=/some/path 
     204Note: If you use the above script you must use the --auth option to tracd, not --basic-auth, and you must set the realm in the --auth value to 'trac' (without the quotes). Example usage (assuming you saved the script as trac-digest.py): 
     205 
     206{{{ 
     207 $ python trac-digest.py -u username -p password >> c:\digest.txt 
     208 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 
     209}}} 
     210 
     211 
     212Note: If you would like to use --basic-auth you need to use htpasswd tool from apache server to generate .htpasswd file. The remaining part is similar but make sure to use empty realm (i.e. coma after path). Make sure to use -m option for it.  If you do not have Apache, [trac:source:/tags/trac-0.11/contrib/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.) 
     213 
     214It is possible to use md5sum utility to generate digest-password file using such method: 
     215{{{ 
     216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 
     217}}} 
     218and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 
     219 
     220== Tips == 
     221 
     222=== Serving static content === 
     223 
     224If `tracd` is the only web server used for the project,  
     225it can also be used to distribute static content  
     226(tarballs, Doxygen documentation, etc.) 
     227 
     228This static content should be put in the `$TRAC_ENV/htdocs` folder, 
     229and is accessed by URLs like `<project_URL>/chrome/site/...`. 
     230 
     231Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
     232the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,  
     233which in turn can be written as `htdocs:software-0.1.tar.gz` (TracLinks syntax) or `[/<project_name>/chrome/site/software-0.1.tar.gz]` (relative link syntax).  
     234 
     235 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 
     236 
     237=== Using apache rewrite rules === 
     238In some situations when you choose to use tracd behind apache, you might experience issues with redirects, like being redirected to URLs with the wrong host or protocol. In this case (and only in this case), setting the `[trac] use_base_url_for_redirect` to `true` can help, as this will force Trac to use the value of `[trac] base_url` for doing the redirects. 
     239 
     240=== Serving a different base path than / === 
     241Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 
     242{{{ 
     243 $ tracd --base-path=/some/path 
    177244}}} 
    178245 
    179246---- 
    180 See also: TracInstall, TracCgi, TracModPython, TracGuide 
     247See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]