Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
2011-01-15 11:33:03 (9 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 
     62{{{#!div 
     63Once the service is installed, it might be simpler to run the Registry Editor rather than use the `reg add` command documented above.  Navigate to:[[BR]] 
     64`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters` 
     65 
     66Three (string) parameters are provided: 
     67||!AppDirectory ||C:\Python26\ || 
     68||Application ||python.exe || 
     69||!AppParameters ||scripts\tracd-script.py -p 8080 ... || 
     70 
     71Note that, if the !AppDirectory is set as above, the paths of the executable ''and'' of the script name and parameter values are relative to the directory.  This makes updating Python a little simpler because the change can be limited, here, to a single point. 
     72(This is true for the path to the .htpasswd file, as well, despite the documentation calling out the /full/path/to/htpasswd; however, you may not wish to store that file under the Python directory.) 
     73}}} 
     74 
     75For 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: 
     76{{{ 
     77"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>" 
     78 
     79net start tracd 
     80}}} 
     81 
     82=== Option 2 === 
     83 
     84Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 
     85 
    6186== Using Authentication == 
    6287 
    63 Using tracd with Apache .htpasswd files: 
    64  
    65 To create a .htpasswd file using htpasswd: 
     88Tracd 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.) 
     89 
     90 
     91The general format for using authentication is: 
     92{{{ 
     93 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 
     94}}} 
     95 
     96where: 
     97 
     98 * '''base_project_dir''': the base directory of the project specified as follows: 
     99   * when serving multiple projects: ''relative'' to the `project_path` 
     100   * when serving only a single project (`-s`): the name of the project directory 
     101 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. 
     102 * '''password_file_path''': path to the password file 
     103 * '''realm''': the realm name (can be anything) 
     104 * '''project_path''': path of the project 
     105 * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth 
     106 
     107Examples: 
     108 
     109{{{ 
     110 $ tracd -p 8080 \ 
     111   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 
     112}}} 
     113 
     114Of course, the password file can be be shared so that it is used for more than one project: 
     115{{{ 
     116 $ tracd -p 8080 \ 
     117   --auth="project1,/path/to/passwordfile,mycompany.com" \ 
     118   --auth="project2,/path/to/passwordfile,mycompany.com" \ 
     119   /path/to/project1 /path/to/project2 
     120}}} 
     121 
     122Another way to share the password file is to specify "*" for the project name: 
     123{{{ 
     124 $ tracd -p 8080 \ 
     125   --auth="*,/path/to/users.htdigest,mycompany.com" \ 
     126   /path/to/project1 /path/to/project2 
     127}}} 
     128 
     129=== Using a htpasswd password file === 
     130This section describes how to use `tracd` with Apache .htpasswd files. 
     131 
     132To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 
    66133 
    67134{{{ 
     
    72139 $ sudo htpasswd /path/to/env/.htpasswd username2 
    73140}}} 
    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 == 
     141 
     142Then to start `tracd` run something like this: 
     143 
     144{{{ 
     145 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 
     146}}} 
     147 
     148For example: 
     149 
     150{{{ 
     151 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 
     152}}} 
     153 
     154''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 
     155 
     156=== Using a htdigest password file === 
    120157 
    121158If 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. 
     
    123160Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
    124161 
    125 == Generating Passwords Without Apache == 
     162=== Generating Passwords Without Apache === 
    126163 
    127164If you don't have Apache available, you can use this simple Python script to generate your passwords: 
     
    166203}}} 
    167204 
    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.) 
     205 
     206Note: 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.) 
    169207 
    170208It is possible to use md5sum utility to generate digest-password file using such method: 
     
    174212and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 
    175213 
     214== Reference == 
     215 
     216Here's the online help, as a reminder (`tracd --help`): 
     217{{{ 
     218Usage: tracd [options] [projenv] ... 
     219 
     220Options: 
     221  --version             show program's version number and exit 
     222  -h, --help            show this help message and exit 
     223  -a DIGESTAUTH, --auth=DIGESTAUTH 
     224                        [projectdir],[htdigest_file],[realm] 
     225  --basic-auth=BASICAUTH 
     226                        [projectdir],[htpasswd_file],[realm] 
     227  -p PORT, --port=PORT  the port number to bind to 
     228  -b HOSTNAME, --hostname=HOSTNAME 
     229                        the host name or IP address to bind to 
     230  --protocol=PROTOCOL   http|scgi|ajp 
     231  -q, --unquote         unquote PATH_INFO (may be needed when using ajp) 
     232  --http10              use HTTP/1.0 protocol version (default) 
     233  --http11              use HTTP/1.1 protocol version instead of HTTP/1.0 
     234  -e PARENTDIR, --env-parent-dir=PARENTDIR 
     235                        parent directory of the project environments 
     236  --base-path=BASE_PATH 
     237                        the initial portion of the request URL's "path" 
     238  -r, --auto-reload     restart automatically when sources are modified 
     239  -s, --single-env      only serve a single project without the project list 
     240}}} 
     241 
    176242== Tips == 
    177243 
    178244=== Serving static content === 
    179245 
    180 If `tracd` is the only webserver used for the project,  
     246If `tracd` is the only web server used for the project,  
    181247it can also be used to distribute static content  
    182248(tarballs, Doxygen documentation, etc.) 
     
    187253Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
    188254the 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`.  
    195  
    196 === Using apache rewrite rules === 
    197 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. 
     255which 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).  
     256 
     257 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 
     258 
     259=== Using tracd behind a proxy 
     260 
     261In some situations when you choose to use tracd behind Apache or another web server. 
     262 
     263In this situation, 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. 
     264 
     265If you're using the AJP protocol to connect with `tracd` (which is possible if you have flup installed), then you might experience problems with double quoting. Consider adding the `--unquote` parameter. 
     266 
     267See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]. 
    198268 
    199269=== Serving a different base path than / === 
     
    204274 
    205275---- 
    206 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service] 
     276See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]