Changes between Version 4 and Version 5 of TracStandalone


Ignore:
Timestamp:
Apr 13, 2010, 3:53:03 AM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v4 v5  
    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.
     
    4342== Installing as a Windows Service ==
    4443
    45 === Option 1 ===
    4644To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    4745{{{
     
    6058The spacing here is important.
    6159
    62 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:
    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 
    66 net start tracd
    67 }}}
    68 
    69 === Option 2 ===
    70 
    71 Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    72 
    7360== Using Authentication ==
    7461
     
    7865
    7966{{{
    80  $ sudo htpasswd -c /path/to/env/.htpasswd username
     67sudo htpasswd -c /path/to/env/.htpasswd username
    8168}}}
    8269then for additional users:
    8370{{{
    84  $ sudo htpasswd /path/to/env/.htpasswd username2
    85 }}}
    86 then for starting the tracd (on windows skip the "=" after --basic-auth):
     71sudo htpasswd /path/to/env/.htpasswd username2
     72}}}
     73then for starting the tracd:
    8774{{{
    8875tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
    8976}}}
    9077
    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.
    9278
    9379Tracd 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.)
     
    9581  ''Support for Basic authentication was added in version 0.9.''
    9682
    97 The 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
     83The general format for using authentication is:
     84
     85{{{
     86 $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
    10187}}}
    10288
    10389where:
    10490
    105  * '''base_project_dir''': the base directory of the project specified as follows:
    106    * when serving multiple projects: ''relative'' to the `project_bath`
    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 
    113 Examples:
     91 * '''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
     92 * '''password_file_path''' path of the password file
     93 * '''realm''' realm
     94 * '''project_path''' path of the project
     95
     96Example:
    11497
    11598{{{
    11699 $ tracd -p 8080 \
    117    --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
    118 }}}
    119 
    120 Of course, the password file can be be shared so that it is used for more than one project:
     100   --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
     101}}}
     102Of course, the digest file can be be shared so that it is used for more than one project:
    121103{{{
    122104 $ tracd -p 8080 \
    123    --auth="project1,/path/to/passwordfile,mycompany.com" \
    124    --auth="project2,/path/to/passwordfile,mycompany.com" \
     105   --auth=project1,/path/to/users.htdigest,mycompany.com \
     106   --auth=project2,/path/to/users.htdigest,mycompany.com \
    125107   /path/to/project1 /path/to/project2
    126108}}}
    127109
    128 Another way to share the password file is to specify "*" for the project name:
     110Another way to share the digest file is to specify "*"
     111for the project name:
    129112{{{
    130113 $ tracd -p 8080 \
    131    --auth="*,/path/to/users.htdigest,mycompany.com" \
     114   --auth="*",/path/to/users.htdigest,mycompany.com \
    132115   /path/to/project1 /path/to/project2
    133116}}}
    134 
    135 === Using a htpasswd password file ===
    136 This section describes how to use `tracd` with Apache .htpasswd files.
    137 
    138 To 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 }}}
    143 then for additional users:
    144 {{{
    145  $ sudo htpasswd /path/to/env/.htpasswd username2
    146 }}}
    147 
    148 Then to start `tracd` run something like this:
    149 
    150 {{{
    151  $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
    152 }}}
    153 
    154 For 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 ===
     117If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
     118
     119== How to set up an htdigest password file ==
    163120
    164121If 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.
     
    166123Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
    167124
    168 === Generating Passwords Without Apache ===
     125== Generating Passwords Without Apache ==
    169126
    170127If you don't have Apache available, you can use this simple Python script to generate your passwords:
     
    205162
    206163{{{
    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 
    212 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.)
     164python trac-digest.py -u username -p password >> c:\digest.txt
     165tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     166}}}
     167
     168Note: 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.)
    213169
    214170It is possible to use md5sum utility to generate digest-password file using such method:
     
    222178=== Serving static content ===
    223179
    224 If `tracd` is the only web server used for the project,
     180If `tracd` is the only webserver used for the project,
    225181it can also be used to distribute static content
    226182(tarballs, Doxygen documentation, etc.)
     
    231187Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    232188the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    233 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).
    234 
    235  ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
     189which in turn can be written using the relative link syntax
     190in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
     191
     192The development version of Trac supports a new `htdocs:` TracLinks
     193syntax for the above. With this, the example link above can be written simply
     194`htdocs:software-0.1.tar.gz`.
    236195
    237196=== Using apache rewrite rules ===
     
    245204
    246205----
    247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]
     206See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png