Changes between Version 2 and Version 3 of TracStandalone


Ignore:
Timestamp:
04/04/12 14:28:09 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v2 v3  
    11= Tracd =
    22
    3 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].
     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.
    45
    56== Pros ==
    67
    78 * Fewer dependencies: You don't need to install apache or any other web-server.
    8  * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
     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
    910 * 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).
    1011
    1112== Cons ==
    1213
    13  * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD.
     14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd.
    1415 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
    1516   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
     
    4647== Installing as a Windows Service ==
    4748
     49=== Option 1 ===
    4850To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    4951{{{
     
    7274The spacing here is important.
    7375
     76For 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:
     77{{{
     78"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>"
     79
     80net start tracd
     81}}}
     82
     83=== Option 2 ===
     84
     85Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     86
    7487== Using Authentication ==
    7588
     
    7992
    8093{{{
    81 sudo htpasswd -c /path/to/env/.htpasswd username
     94 $ htpasswd -c /path/to/env/.htpasswd username
    8295}}}
    8396then for additional users:
    8497{{{
    85 sudo htpasswd /path/to/env/.htpasswd username2
    86 }}}
    87 then for starting the tracd:
     98 $ htpasswd /path/to/env/.htpasswd username2
     99}}}
     100then for starting the tracd (on windows skip the "=" after --basic-auth):
    88101{{{
    89102tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
    90103}}}
    91104
     105 `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.
    92106
    93107Tracd 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.)
     
    95109  ''Support for Basic authentication was added in version 0.9.''
    96110
    97 The general format for using authentication is:
    98 
    99 {{{
    100  $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
     111The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth):
     112
     113{{{
     114 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    101115}}}
    102116
    103117where:
    104118
    105  * '''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
    106  * '''password_file_path''' path of the password file
    107  * '''realm''' realm
    108  * '''project_path''' path of the project
    109 
    110 Example:
     119 * '''base_project_dir''': the base directory of the project specified as follows:
     120   * when serving multiple projects: ''relative'' to the `project_path`
     121   * when serving only a single project (`-s`): the name of the project directory
     122 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
     123 * '''password_file_path''': path to the password file
     124 * '''realm''': the realm name (can be anything)
     125 * '''project_path''': path of the project
     126
     127Examples:
    111128
    112129{{{
    113130 $ tracd -p 8080 \
    114    --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
    115 }}}
    116 Of course, the digest file can be be shared so that it is used for more than one project:
     131   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
     132}}}
     133
     134Of course, the password file can be be shared so that it is used for more than one project:
    117135{{{
    118136 $ tracd -p 8080 \
    119    --auth=project1,/path/to/users.htdigest,mycompany.com \
    120    --auth=project2,/path/to/users.htdigest,mycompany.com \
     137   --auth="project1,/path/to/passwordfile,mycompany.com" \
     138   --auth="project2,/path/to/passwordfile,mycompany.com" \
    121139   /path/to/project1 /path/to/project2
    122140}}}
    123141
    124 Another way to share the digest file is to specify "*"
    125 for the project name:
     142Another way to share the password file is to specify "*" for the project name:
    126143{{{
    127144 $ tracd -p 8080 \
    128    --auth="*",/path/to/users.htdigest,mycompany.com \
     145   --auth="*,/path/to/users.htdigest,mycompany.com" \
    129146   /path/to/project1 /path/to/project2
    130147}}}
    131 If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
    132 
    133 == How to set up an htdigest password file ==
     148
     149=== Using a htpasswd password file ===
     150This section describes how to use `tracd` with Apache .htpasswd files.
     151
     152To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     153
     154{{{
     155 $ sudo htpasswd -c /path/to/env/.htpasswd username
     156}}}
     157then for additional users:
     158{{{
     159 $ sudo htpasswd /path/to/env/.htpasswd username2
     160}}}
     161
     162Then to start `tracd` run something like this:
     163
     164{{{
     165 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     166}}}
     167
     168For example:
     169
     170{{{
     171 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     172}}}
     173
     174''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     175
     176=== Using a htdigest password file ===
    134177
    135178If 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.
     
    137180Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
    138181
    139 == Generating Passwords Without Apache ==
     182=== Generating Passwords Without Apache ===
    140183
    141184If you don't have Apache available, you can use this simple Python script to generate your passwords:
     
    176219
    177220{{{
    178 python trac-digest.py -u username -p password >> c:\digest.txt
    179 tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
    180 }}}
    181 
    182 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.)
     221 $ python trac-digest.py -u username -p password >> c:\digest.txt
     222 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     223}}}
     224
     225
     226Note: 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.)
    183227
    184228It is possible to use md5sum utility to generate digest-password file using such method:
     
    192236=== Serving static content ===
    193237
    194 If `tracd` is the only webserver used for the project,
     238If `tracd` is the only web server used for the project,
    195239it can also be used to distribute static content
    196240(tarballs, Doxygen documentation, etc.)
     
    201245Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    202246the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    203 which in turn can be written using the relative link syntax
    204 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
    205 
    206 The development version of Trac supports a new `htdocs:` TracLinks
    207 syntax for the above. With this, the example link above can be written simply
    208 `htdocs:software-0.1.tar.gz`.
     247which 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).
     248
     249 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
    209250
    210251=== Using apache rewrite rules ===
     
    218259
    219260----
    220 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]
    221 
     261See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]
     262