Changes between Version 5 and Version 6 of TracStandalone

Timestamp:

01/28/10 04:25:37 (7 months ago)

Author:

trac (IP: 127.0.0.1)

Comment:

--

TracStandalone

@@ -1 +1 @@
 = Tracd =
 
-Tracd は軽量なスタンドアロンの Trac web サーバです。ほとんどのケースでは [wiki:TracCgi CGI] よりセットアップが簡単で、処理速度も速くなります。
+Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script].
 
-== 利点 ==
+== Pros ==
 
- * 依存性が低い: apache その他 web サーバをインストールする必要がありません。
- * 速い: [wiki:TracModPython mod_python] バージョンと同じくらい速いでしょう。 ([wiki:TracCgi CGI] よりはずっと速い)。
- * 自動リロード: 開発のために、 Tracd は ''auto_reload'' モードを使用しています。そのため、コード ( Trac 自身またはプラグインのコード ) を更新したときに、自動的にサーバが再起動します。
+ * Fewer dependencies: You don't need to install apache or any other web-server.
+ * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
+ * 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).
 
-== 欠点 ==
+== Cons ==
 
- * 機能が少ない: Tracd に実装されている web サーバはとてもシンプルで、 Apache HTTPD のように拡張性のある設定ができません。
- * ネイティブで HTTPS に対応しない: 代わりに [http://www.rickk.com/sslwrap/ sslwrap] または
-   [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- tracd と stunnel を使うためのチュートリアル] または Apache の mod_proxy を使用します。
+ * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD.
+ * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
+   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
 
-== 使用例 ==
+== Usage examples ==
 
-ポート 8080 に単一のプロジェクトを作成します。 (http://localhost:8080/)
+A single project on port 8080. (http://localhost:8080/)
 {{{
  $ tracd -p 8080 /path/to/project
 }}}
-複数のプロジェクト(http://localhost:8080/project1/ と http://localhost:8080/project2/)
+Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
+{{{
+ $ tracd --hostname=localhost -p 8080 /path/to/project
+}}}
+With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
 {{{
  $ tracd -p 8080 /path/to/project1 /path/to/project2
 }}}
 
-Trac は異なるプロジェクト間の URL の一意性を保つために、パスの一番最後の文字列を使用するため、プロジェクト間でパスの一番最後の部分を同じにすることは出来ません。
-もし、 `/project1/path/to` と `/project2/path/to` を同時に指定した場合、二つ目のプロジェクトだけしか見えなくなります。
+You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the
+different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project.
 
-複数のプロジェクトを動かすもう一つの方法は、 `-e` オプションで親ディレクトリを指定し、サブディレクトリに TracEnvironment を配置します。上記の例は以下のように書き換えられます:
+An 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:
 {{{
  $ tracd -p 8080 -e /path/to
 }}}
 
-== 認証を使用する ==
+To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
 
-Tracd は基本認証とダイジェスト認証の両方に対応しています。デフォルトはダイジェスト認証です; 基本認証を使用するためには、以降の例で使用する `--auth` を `--basic-auth` に置き換え、レルムの指定を削除して下さい。
 
-  ''基本認証への対応はバージョン 0.9 以降で追加されました。''
+== Using Authentication ==
 
-ファイル `/path/to/users.htdigest` に project1 のユーザアカウントをレルム "mycompany.com" として保持している場合、以下に示すコマンドラインで tracd を起動します:
+Using tracd with Apache .htpasswd files:
+
+To create a .htpasswd file using htpasswd:
+
 {{{
- $ tracd -p 8080 --auth project1,/path/to/users.htdigest,mycompany.com /path/to/project1
+sudo htpasswd -c /path/to/env/.htpasswd username
+}}}
+then for additional users:
+{{{
+sudo htpasswd /var/www/html/.htpasswd-users username2
+}}}
+then for starting the tracd:
+{{{
+tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
 }}}
 
-'''Note''': `--auth` オプションで指定するプロジェクトの "名前" はそのプロジェクトの TracEnvironment ディレクトリの basename です。
 
-もちろん、ダイジェストファイルは複数のプロジェクト間で共有することが出来ます:
+Tracd 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.)
+
+  ''Support for Basic authentication was added in version 0.9.''
+
+The general format for using authentication is:
+
+{{{
+ $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
+}}}
+
+where:
+
+ * '''base_project_dir''' is the base directory of the project; note: this doesn't refer to the project name, and it is case-sensitive even for windows environments
+ * '''password_file_path''' path of the password file
+ * '''realm''' realm
+ * '''project_path''' path of the project
+
+Example:
+
 {{{
  $ tracd -p 8080 \
-   --auth project1,/path/to/users.htdigest,mycompany.com \
-   --auth project2,/path/to/users.htdigest,mycompany.com \
+   --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
+}}}
+Of course, the digest file can be be shared so that it is used for more than one project:
+{{{
+ $ tracd -p 8080 \
+   --auth=project1,/path/to/users.htdigest,mycompany.com \
+   --auth=project2,/path/to/users.htdigest,mycompany.com \
    /path/to/project1 /path/to/project2
 }}}
 
-ダイジェストファイルを共有するもうひとつの方法は、プロジェクトの名前に "*" 
-を指定することです:
+Another way to share the digest file is to specify "*"
+for the project name:
 {{{
  $ tracd -p 8080 \
-   --auth *,/path/to/users.htdigest,mycompany.com \
+   --auth=*,/path/to/users.htdigest,mycompany.com \
    /path/to/project1 /path/to/project2
 }}}
 
-== htdigest パスワードファイルの設定方法 ==
+== How to set up an htdigest password file ==
 
-もし、 Apache がインストールされているなら、パスワードファイルを生成するのに、 htdigest コマンドを使用することができます。 'htdigest' とタイプして使用方法を見るか、詳細な使用方法を見るために Apache のマニュアル [http://httpd.apache.org/docs/2.0/programs/htdigest.html このページ] を読んでください。ユーザを生成するたびに、パスワードを入力するように求められます。パスワードファイルの名前には好きな名前をつけることができますが、 `users.htdigest` というような名前にしておけば、ファイルに何が含まれているかを覚えておけるでしょう。指示通り、それを <projectname>/conf フォルダに [TracIni trac.ini] ファイルと一緒において下さい。
+If 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.
 
-引数 --auth なしで tracd をスタートできることに注意して下さい。ただし、 ''ログイン'' リンクをクリックするとエラーになるでしょう。
+Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
 
-== Apache 以外の環境でパスワードを生成する ==
+== Generating Passwords Without Apache ==
 
-もし Apache が使用できない場合でも、簡単な Python スクリプトでパスワードを生成できます:
+If you don't have Apache available, you can use this simple Python script to generate your passwords:
 
 {{{
+#!python
 from optparse import OptionParser
 import md5
@@ -96 +133 @@
 }}}
 
-Note: もし tracd を --basic-auth ではなくて、 --auth オプションを使用して起動するときに、上記のスクリプトを使わないといけないとしたら --auth の値に 'trac' を( シングルクォートなしで ) 指定し、レルムを設定しなければなりません。( 上記スクリプトを trac-digest.py として保存したとします)
+Note: 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):
 
 {{{
 python trac-digest.py -u username -p password >> c:\digest.txt
-python tracd --port 8000 --auth proj_name,c:\digest.txt,trac c:\path\to\proj_name
+tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
 }}}
+
+Note: 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). When using on Windows make sure to use -m option for it (did not tested it on *nix, so not sure if that is the case there).  If you do not have Apache, [trac:source:/tags/trac-0.11b2/contrib/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
+
+It is possible to use md5sum utility to generate digest-password file using such method:
+{{{
+echo -e "${user}:trac:${password}\c" | md5sum - >>to-file
+}}}
+and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. You can see attachment:trac-digest-corrected.sh for detail.
 
 == Tips ==
 
-=== 静的なリソースを扱う ===
+=== Serving static content ===
 
-もし、 `tracd` が単一のプロジェクトのみを扱う Web サーバだとしたら、
-静的なリソースを割り当てるのに使用することができます。
-(tar アーカイブ, Doxygen ドキュメントなど)
+If `tracd` is the only webserver used for the project, 
+it can also be used to distribute static content 
+(tarballs, Doxygen documentation, etc.)
 
-この静的なリソースは `$TRAC_ENV/htdocs` フォルダに置き、
-`<project_URL>/chrome/site/...` という URL でアクセスします。
+This static content should be put in the `$TRAC_ENV/htdocs` folder,
+and is accessed by URLs like `<project_URL>/chrome/site/...`.
 
-例: ファイル名が `$TRAC_ENV/htdocs/software-0.1.tar.gz` だったとき、
-対応する URL は `/<project_name>/chrome/site/software-0.1.tar.gz` となるでしょう。
-そして、wiki には、相対リンクシンタックスを使用して、 
-`[/<project_name>/chrome/site/software-0.1.tar.gz]` と書くことができます。
+Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
+the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 
+which in turn can be written using the relative link syntax
+in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 
 
-Trac の開発バージョンでは新しく `htdocs:` に対応します。 TracLinks は
-上記のようなシンタックスになります。これによって、上記の例のリンクはただ単に 
-`htdocs:software-0.1.tar.gz` と書くことができます。
+The development version of Trac supports a new `htdocs:` TracLinks 
+syntax for the above. With this, the example link above can be written simply 
+`htdocs:software-0.1.tar.gz`. 
+
+=== Using apache rewrite rules ===
+In 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.
+
+=== Serving a different base path than / ===
+Tracd supports serving projects with different base urls then /<project>. The parameter name to change this is
+{{{
+tracd --base-path=/some/path
+}}}
 
 ----
 See also: TracInstall, TracCgi, TracModPython, TracGuide
-
-----
-'''Translation:'''
- * [https://opensvn.csie.org/traccgi/trac_rus/wiki/StandAloneTracForTeapot Russian] (перевод на Русский)