Changes between Version 3 and Version 4 of TracStandalone


Ignore:
Timestamp:
04/04/12 14:28:20 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v3 v4  
    11= Tracd =
    22
    3 Tracd is a lightweight standalone Trac web server.
    4 It 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.
     3Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script].
    54
    65== Pros ==
    76
    87 * 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
     8 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
    109 * 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).
    1110
    1211== Cons ==
    1312
    14  * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd.
     13 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD.
    1514 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
    1615   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
     
    4746== Installing as a Windows Service ==
    4847
    49 === Option 1 ===
    5048To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    5149{{{
     
    7472The spacing here is important.
    7573
    76 For 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 
    80 net start tracd
    81 }}}
    82 
    83 === Option 2 ===
    84 
    85 Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    86 
    8774== Using Authentication ==
    8875
     
    9279
    9380{{{
    94  $ htpasswd -c /path/to/env/.htpasswd username
     81sudo htpasswd -c /path/to/env/.htpasswd username
    9582}}}
    9683then for additional users:
    9784{{{
    98  $ htpasswd /path/to/env/.htpasswd username2
    99 }}}
    100 then for starting the tracd (on windows skip the "=" after --basic-auth):
     85sudo htpasswd /path/to/env/.htpasswd username2
     86}}}
     87then for starting the tracd:
    10188{{{
    10289tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
    10390}}}
    10491
    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.
    10692
    10793Tracd 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.)
     
    10995  ''Support for Basic authentication was added in version 0.9.''
    11096
    111 The 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
     97The general format for using authentication is:
     98
     99{{{
     100 $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
    115101}}}
    116102
    117103where:
    118104
    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 
    127 Examples:
     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
     110Example:
    128111
    129112{{{
    130113 $ tracd -p 8080 \
    131    --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
    132 }}}
    133 
    134 Of course, the password file can be be shared so that it is used for more than one project:
     114   --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
     115}}}
     116Of course, the digest file can be be shared so that it is used for more than one project:
    135117{{{
    136118 $ tracd -p 8080 \
    137    --auth="project1,/path/to/passwordfile,mycompany.com" \
    138    --auth="project2,/path/to/passwordfile,mycompany.com" \
     119   --auth=project1,/path/to/users.htdigest,mycompany.com \
     120   --auth=project2,/path/to/users.htdigest,mycompany.com \
    139121   /path/to/project1 /path/to/project2
    140122}}}
    141123
    142 Another way to share the password file is to specify "*" for the project name:
     124Another way to share the digest file is to specify "*"
     125for the project name:
    143126{{{
    144127 $ tracd -p 8080 \
    145    --auth="*,/path/to/users.htdigest,mycompany.com" \
     128   --auth="*",/path/to/users.htdigest,mycompany.com \
    146129   /path/to/project1 /path/to/project2
    147130}}}
    148 
    149 === Using a htpasswd password file ===
    150 This section describes how to use `tracd` with Apache .htpasswd files.
    151 
    152 To 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 }}}
    157 then for additional users:
    158 {{{
    159  $ sudo htpasswd /path/to/env/.htpasswd username2
    160 }}}
    161 
    162 Then to start `tracd` run something like this:
    163 
    164 {{{
    165  $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
    166 }}}
    167 
    168 For 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 ===
     131If 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 ==
    177134
    178135If 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.
     
    180137Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
    181138
    182 === Generating Passwords Without Apache ===
     139== Generating Passwords Without Apache ==
    183140
    184141If you don't have Apache available, you can use this simple Python script to generate your passwords:
     
    219176
    220177{{{
    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 
    226 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). 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.)
     178python trac-digest.py -u username -p password >> c:\digest.txt
     179tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     180}}}
     181
     182Note: 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.)
    227183
    228184It is possible to use md5sum utility to generate digest-password file using such method:
     
    236192=== Serving static content ===
    237193
    238 If `tracd` is the only web server used for the project,
     194If `tracd` is the only webserver used for the project,
    239195it can also be used to distribute static content
    240196(tarballs, Doxygen documentation, etc.)
     
    245201Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    246202the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    247 which 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''
     203which in turn can be written using the relative link syntax
     204in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
     205
     206The development version of Trac supports a new `htdocs:` TracLinks
     207syntax for the above. With this, the example link above can be written simply
     208`htdocs:software-0.1.tar.gz`.
    250209
    251210=== Using apache rewrite rules ===
     
    259218
    260219----
    261 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]
    262 
     220See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]
     221