Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
Jun 14, 2010 11:11:20 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v2  
    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). 
    10   * Options for tracd: `-r, --auto-reload` 
    1111 
    1212== Cons == 
    1313 
    14  * 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. 
    1515 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 
    1616   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. 
     
    4343== Installing as a Windows Service == 
    4444 
     45=== Option 1 === 
    4546To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run: 
    4647{{{ 
     
    5960The spacing here is important. 
    6061 
     62For 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 
     66net start tracd 
     67}}} 
     68 
     69=== Option 2 === 
     70 
     71Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 
     72 
    6173== Using Authentication == 
    6274 
     
    6678 
    6779{{{ 
     80 $ htpasswd -c /path/to/env/.htpasswd username 
     81}}} 
     82then for additional users: 
     83{{{ 
     84 $ htpasswd /path/to/env/.htpasswd username2 
     85}}} 
     86then for starting the tracd (on windows skip the "=" after --basic-auth): 
     87{{{ 
     88tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 
     89}}} 
     90 
     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. 
     92 
     93Tracd 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.) 
     94 
     95  ''Support for Basic authentication was added in version 0.9.'' 
     96 
     97The 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 
     101}}} 
     102 
     103where: 
     104 
     105 * '''base_project_dir''': the base directory of the project specified as follows: 
     106   * when serving multiple projects: ''relative'' to the `project_path` 
     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 
     113Examples: 
     114 
     115{{{ 
     116 $ tracd -p 8080 \ 
     117   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 
     118}}} 
     119 
     120Of course, the password file can be be shared so that it is used for more than one project: 
     121{{{ 
     122 $ tracd -p 8080 \ 
     123   --auth="project1,/path/to/passwordfile,mycompany.com" \ 
     124   --auth="project2,/path/to/passwordfile,mycompany.com" \ 
     125   /path/to/project1 /path/to/project2 
     126}}} 
     127 
     128Another way to share the password file is to specify "*" for the project name: 
     129{{{ 
     130 $ tracd -p 8080 \ 
     131   --auth="*,/path/to/users.htdigest,mycompany.com" \ 
     132   /path/to/project1 /path/to/project2 
     133}}} 
     134 
     135=== Using a htpasswd password file === 
     136This section describes how to use `tracd` with Apache .htpasswd files. 
     137 
     138To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 
     139 
     140{{{ 
    68141 $ sudo htpasswd -c /path/to/env/.htpasswd username 
    69142}}} 
     
    72145 $ sudo htpasswd /path/to/env/.htpasswd username2 
    73146}}} 
    74 then for starting the tracd (on windows skip the "=" after --basic-auth): 
    75 {{{ 
    76  $ tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 
    77 }}} 
    78  
    79 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.) 
    80  
    81   ''Support for Basic authentication was added in version 0.9.'' 
    82  
    83 The general format for using authentication is (on windows skip the "=" after --auth): 
    84  
    85 {{{ 
    86  $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path 
    87 }}} 
    88  
    89 where: 
    90  
    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  
    96 Example (on windows skip the "=" after --auth): 
    97  
    98 {{{ 
    99  $ tracd -p 8080 \ 
    100    --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 
    101 }}} 
    102 Of course, the digest file can be be shared so that it is used for more than one project: 
    103 {{{ 
    104  $ tracd -p 8080 \ 
    105    --auth=project1,/path/to/users.htdigest,mycompany.com \ 
    106    --auth=project2,/path/to/users.htdigest,mycompany.com \ 
    107    /path/to/project1 /path/to/project2 
    108 }}} 
    109  
    110 Another way to share the digest file is to specify "*" 
    111 for the project name: 
    112 {{{ 
    113  $ tracd -p 8080 \ 
    114    --auth="*",/path/to/users.htdigest,mycompany.com \ 
    115    /path/to/project1 /path/to/project2 
    116 }}} 
    117 If 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 == 
     147 
     148Then to start `tracd` run something like this: 
     149 
     150{{{ 
     151 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 
     152}}} 
     153 
     154For 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 === 
    120163 
    121164If 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. 
     
    123166Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
    124167 
    125 == Generating Passwords Without Apache == 
     168=== Generating Passwords Without Apache === 
    126169 
    127170If you don't have Apache available, you can use this simple Python script to generate your passwords: 
     
    166209}}} 
    167210 
    168 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.) 
     211 
     212Note: 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.) 
    169213 
    170214It is possible to use md5sum utility to generate digest-password file using such method: 
     
    178222=== Serving static content === 
    179223 
    180 If `tracd` is the only webserver used for the project,  
     224If `tracd` is the only web server used for the project,  
    181225it can also be used to distribute static content  
    182226(tarballs, Doxygen documentation, etc.) 
     
    187231Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
    188232the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,  
    189 which in turn can be written using the relative link syntax 
    190 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`  
    191  
    192 Since 0.10, Trac supports a new `htdocs:` TracLinks  
    193 syntax for the above. With this, the example link above can be written simply  
    194 `htdocs:software-0.1.tar.gz`.  
     233which 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'' 
    195236 
    196237=== Using apache rewrite rules === 
     
    204245 
    205246---- 
    206 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service] 
     247See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]