Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
Jan 5, 2015 9:18:11 PM (10 years ago)
Author:
trac
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 [http://www.google.com/search?q=srvany.exe SRVANY] などのユーティリティを使用して Windows のサービスとして起動する場合、サービスの停止や再起動では Python プロセスが残留してしまいます。代わりにシステムを再起動してください。 
    43  
    44  
    45 == 認証を使用する == #UsingAuthentication 
    46  
    47 tracd は Apache の .htpasswd ファイルを使用できます: 
    48  
    49 .htpasswd ファイルは htpasswd コマンドを使用して作成します: 
    50  
    51 {{{ 
    52 sudo htpasswd -c /path/to/env/.htpasswd username 
    53 }}} 
    54 ユーザを追加する場合は以下の通りです: 
    55 {{{ 
    56 sudo htpasswd /path/to/env/.htpasswd username2 
    57 }}} 
    58 tracd の起動オプションにファイルを指定してください: 
    59 {{{ 
    60 tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 
    61 }}} 
    62  
    63  
    64 Tracd は基本認証とダイジェスト認証の両方に対応しています。デフォルトはダイジェスト認証です; 基本認証を使用するためには、以降の例で使用する `--auth` を `--basic-auth` に置き換えて下さい。 (ダイアログに使用する "realm" を指定しなければなりません。 BASICAUTH には カンマ を末尾に指定した空の文字列を指定することができます。) 
    65  
    66   ''基本認証への対応はバージョン 0.9 以降で追加されました。'' 
    67  
    68 認証を使用するための一般的なコマンドは以下の通りです: 
    69  
    70 {{{ 
    71  $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path 
    72 }}} 
    73  
    74 オプションについて: 
    75  
    76  * '''base_project_dir''' はプロジェクトのベースディレクトリ; Note: これはプロジェクト名ではありません。そして Windows の環境においても、大文字と小文字を区別します。 
    77  * '''password_file_path''' パスワードファイルのパス 
    78  * '''realm''' レルム 
    79  * '''project_path''' プロジェクトのパス 
    80  
    81 使用例: 
     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 
     62{{{#!div 
     63Once the service is installed, it might be simpler to run the Registry Editor rather than use the `reg add` command documented above.  Navigate to:[[BR]] 
     64`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters` 
     65 
     66Three (string) parameters are provided: 
     67||!AppDirectory ||C:\Python26\ || 
     68||Application ||python.exe || 
     69||!AppParameters ||scripts\tracd-script.py -p 8080 ... || 
     70 
     71Note that, if the !AppDirectory is set as above, the paths of the executable ''and'' of the script name and parameter values are relative to the directory.  This makes updating Python a little simpler because the change can be limited, here, to a single point. 
     72(This is true for the path to the .htpasswd file, as well, despite the documentation calling out the /full/path/to/htpasswd; however, you may not wish to store that file under the Python directory.) 
     73}}} 
     74 
     75For 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: 
     76{{{ 
     77"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>" 
     78 
     79net start tracd 
     80}}} 
     81 
     82=== Option 2 === 
     83 
     84Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 
     85 
     86== Using Authentication == 
     87 
     88Tracd provides support for both Basic and Digest authentication. Digest is considered more secure. The examples below use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the command line. 
     89 
     90The general format for using authentication is: 
     91{{{ 
     92 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 
     93}}} 
     94where: 
     95 * '''base_project_dir''': the base directory of the project specified as follows: 
     96   * when serving multiple projects: ''relative'' to the `project_path` 
     97   * when serving only a single project (`-s`): the name of the project directory 
     98 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. 
     99 * '''password_file_path''': path to the password file 
     100 * '''realm''': the realm name (can be anything) 
     101 * '''project_path''': path of the project 
     102 
     103 * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth.  Although Basic authentication does not require a "realm", the command parser does, so the second comma is required, followed directly by the closing quote for an empty realm name. 
     104 
     105Examples: 
    82106 
    83107{{{ 
    84108 $ tracd -p 8080 \ 
    85    --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 
    86 }}} 
    87 もちろん、ダイジェストファイルは複数のプロジェクト間で共有することが出来ます: 
     109   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 
     110}}} 
     111 
     112Of course, the password file can be be shared so that it is used for more than one project: 
    88113{{{ 
    89114 $ tracd -p 8080 \ 
    90    --auth=project1,/path/to/users.htdigest,mycompany.com \ 
    91    --auth=project2,/path/to/users.htdigest,mycompany.com \ 
     115   --auth="project1,/path/to/passwordfile,mycompany.com" \ 
     116   --auth="project2,/path/to/passwordfile,mycompany.com" \ 
    92117   /path/to/project1 /path/to/project2 
    93118}}} 
    94119 
    95 ダイジェストファイルを共有するもうひとつの方法は、プロジェクトの名前に "*"  
    96 を指定することです: 
     120Another way to share the password file is to specify "*" for the project name: 
    97121{{{ 
    98122 $ tracd -p 8080 \ 
    99    --auth="*",/path/to/users.htdigest,mycompany.com \ 
     123   --auth="*,/path/to/users.htdigest,mycompany.com" \ 
    100124   /path/to/project1 /path/to/project2 
    101125}}} 
    102 `-s` パラメータを使用すると、一つの Trac environment をドメインのルートとして提供するようになり、プロジェクト名として `*` を使用せねばなりません。 
    103  
    104 == htdigest パスワードファイルの設定方法 == #Howtosetupanhtdigestpasswordfile 
    105  
    106 もし、 Apache がインストールされているなら、パスワードファイルを生成するのに、 htdigest コマンドを使用することができます。 'htdigest' とタイプして使用方法を見るか、詳細な使用方法を見るために Apache のマニュアルの [http://httpd.apache.org/docs/2.0/programs/htdigest.html このページ] を読んでください。ユーザを作成するたびに、パスワードを入力するように求められます。パスワードファイルの名前には好きな名前をつけることができますが、 `users.htdigest` というような名前にしておけば、ファイルに何が含まれているかを覚えておけるでしょう。このファイルは <projectname>/conf フォルダに [TracIni trac.ini] ファイルと一緒に置いておくとよいでしょう。 
    107  
    108 引数 --auth なしで tracd をスタートできることに注意して下さい。ただし、 ''ログイン'' (英語版では ''Login'') リンクをクリックするとエラーになります。 
    109  
    110 == Apache 以外の環境でパスワードを生成する == #GeneratingPasswordsWithoutApache 
    111  
    112 もし Apache が使用できない場合でも、簡単な Python スクリプトでパスワードを生成できます: 
     126 
     127=== Basic Authorization: Using a htpasswd password file === 
     128This section describes how to use `tracd` with Apache .htpasswd files. 
     129 
     130To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 
     131{{{ 
     132 $ sudo htpasswd -c /path/to/env/.htpasswd username 
     133}}} 
     134then for additional users: 
     135{{{ 
     136 $ sudo htpasswd /path/to/env/.htpasswd username2 
     137}}} 
     138 
     139Then to start `tracd` run something like this: 
     140{{{ 
     141 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 
     142}}} 
     143 
     144For example: 
     145{{{ 
     146 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 
     147}}} 
     148''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 
     149 
     150=== Digest authentication: Using a htdigest password file === 
     151 
     152If 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. 
     153 
     154Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
     155 
     156=== Generating Passwords Without Apache === 
     157 
     158Basic Authorization can be accomplished via this [http://www.4webhelp.net/us/password.php online HTTP Password generator].  Copy the generated password-hash line to the .htpasswd file on your system. 
     159 
     160You can use this simple Python script to generate a '''digest''' password file: 
    113161 
    114162{{{ 
    … …  
    144192}}} 
    145193 
    146 Note: もし tracd を --basic-auth ではなくて、 --auth オプションを使用して起動するときに、上記のスクリプトを使わないといけないとしたら --auth の値に 'trac' を(シングルクォートなしで) 指定し、レルムを設定しなければなりません。(上記スクリプトを trac-digest.py として保存したとします) 
    147  
    148 {{{ 
    149 python trac-digest.py -u username -p password >> c:\digest.txt 
    150 tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 
    151 }}} 
    152  
    153 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` モジュールが必要です; ソースのコメントに詳細が書いてあります。) 
    154  
    155 md5sum ユーティリティを使用するとダイジェストパスワードを作成することができます: 
    156 {{{ 
    157 echo -e "${user}:trac:${password}\c" | md5sum - >>to-file 
    158 }}} 
    159 'to-file' は手で編集が必要です。行末の " -" を削除し、行頭に "${user}:trac:" を追加してください。詳細は [http://trac.edgewall.org/attachment/wiki/TracStandalone/trac-digest-corrected.sh trac-digest-corrected.sh] を参照してください。 (訳注: realm が `trac` に固定されていますので、実際には改造しないと使えないでしょう) 
    160  
    161 == Tips == #Tips 
    162  
    163 === 静的なリソースを扱う === #Servingstaticcontent 
    164  
    165 もし、 `tracd` が単一のプロジェクトのみを扱う Web サーバだとしたら、 
    166 静的なリソースを割り当てるのに使用することができます。 
    167 (tar アーカイブ, Doxygen ドキュメントなど) 
    168  
    169 この静的なリソースは `$TRAC_ENV/htdocs` フォルダに置き、 
    170 `<project_URL>/chrome/site/...` という URL でアクセスします。 
    171  
    172 例: ファイル名が `$TRAC_ENV/htdocs/software-0.1.tar.gz` だったとき、 
    173 対応する URL は `/<project_name>/chrome/site/software-0.1.tar.gz` となります。 
    174 Wiki には、相対リンクシンタックスを使用して、  
    175 `[/<project_name>/chrome/site/software-0.1.tar.gz]` と書くことができます。 (訳注: `[/chrome/site/software-0.1.tar.gz]` が正しい) 
    176  
    177 Trac の開発バージョンでは新しく `htdocs:` に対応します。 TracLinks は 
    178 上記のようなシンタックスになります。これによって、上記の例のリンクはただ単に  
    179 `htdocs:software-0.1.tar.gz` と書くことができます。 
    180  
    181 === Apache の書き換え規則を使用する === #Usingapacherewriterules 
    182 Apache のビハインドで tracd を使用すると、いくつかの状況で不正なホストまたはプロトコルに URL をリダイレクトされる問題が発生するかもしれません。この場合 (この場合だけ) `[trac] use_base_url_for_redirect` を `true` に設定することができます。これによって Trac がやむを得ず `[trac] base_url` の値を使用するためリダイレクトを行います。 
    183  
    184 === 検索パスとは別のベースパス (/) === #Servingadifferentbasepaththan 
    185 Tracd は、プロジェクト毎に異なるベース URL 、および /<project> をサポートします。コマンドは以下の通りです。 
    186 {{{ 
    187 tracd --base-path=/some/path 
     194Note: If you use the above script you must set the realm in the `--auth` argument to '''`trac`'''. Example usage (assuming you saved the script as trac-digest.py): 
     195 
     196{{{ 
     197 $ python trac-digest.py -u username -p password >> c:\digest.txt 
     198 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 
     199}}} 
     200 
     201==== Using `md5sum` 
     202It is possible to use `md5sum` utility to generate digest-password file: 
     203{{{ 
     204 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 
     205}}} 
     206and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 
     207 
     208== Reference == 
     209 
     210Here's the online help, as a reminder (`tracd --help`): 
     211{{{ 
     212Usage: tracd [options] [projenv] ... 
     213 
     214Options: 
     215  --version             show program's version number and exit 
     216  -h, --help            show this help message and exit 
     217  -a DIGESTAUTH, --auth=DIGESTAUTH 
     218                        [projectdir],[htdigest_file],[realm] 
     219  --basic-auth=BASICAUTH 
     220                        [projectdir],[htpasswd_file],[realm] 
     221  -p PORT, --port=PORT  the port number to bind to 
     222  -b HOSTNAME, --hostname=HOSTNAME 
     223                        the host name or IP address to bind to 
     224  --protocol=PROTOCOL   http|scgi|ajp 
     225  -q, --unquote         unquote PATH_INFO (may be needed when using ajp) 
     226  --http10              use HTTP/1.0 protocol version (default) 
     227  --http11              use HTTP/1.1 protocol version instead of HTTP/1.0 
     228  -e PARENTDIR, --env-parent-dir=PARENTDIR 
     229                        parent directory of the project environments 
     230  --base-path=BASE_PATH 
     231                        the initial portion of the request URL's "path" 
     232  -r, --auto-reload     restart automatically when sources are modified 
     233  -s, --single-env      only serve a single project without the project list 
     234}}} 
     235 
     236== Tips == 
     237 
     238=== Serving static content === 
     239 
     240If `tracd` is the only web server used for the project,  
     241it can also be used to distribute static content  
     242(tarballs, Doxygen documentation, etc.) 
     243 
     244This static content should be put in the `$TRAC_ENV/htdocs` folder, 
     245and is accessed by URLs like `<project_URL>/chrome/site/...`. 
     246 
     247Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
     248the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,  
     249which 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).  
     250 
     251 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 
     252 
     253=== Using tracd behind a proxy 
     254 
     255In some situations when you choose to use tracd behind Apache or another web server. 
     256 
     257In this situation, 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. 
     258 
     259If you're using the AJP protocol to connect with `tracd` (which is possible if you have flup installed), then you might experience problems with double quoting. Consider adding the `--unquote` parameter. 
     260 
     261See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]. 
     262 
     263=== Serving a different base path than / === 
     264Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 
     265{{{ 
     266 $ tracd --base-path=/some/path 
    188267}}} 
    189268 
    190269---- 
    191 See also: TracInstall, TracCgi, TracModPython, TracGuide, [http://trac.edgewall.org/wiki/TracOnWindowsStandalone?version=13#RunningTracdasservice tracd.exe を Windows のサービスとして起動する] 
     270See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]