Changes between Version 4 and Version 5 of TracStandalone


Ignore:
Timestamp:
01/24/11 13:49:18 (15 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. 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. 
    … …  
    6060The spacing here is important. 
    6161 
     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 
    6275For 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: 
    6376{{{ 
    … …  
    7285 
    7386== Using Authentication == 
    74 `tracd` provides support for both Basic and Digest authentication. The default is to use Digest. 
    75  
    76   ''Support for Basic authentication was added in version 0.9.'' 
    77  
    78 The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth): 
    79  
     87 
     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: 
    8092{{{ 
    8193 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 
    … …  
    8597 
    8698 * '''base_project_dir''': the base directory of the project specified as follows: 
    87    * when serving multiple projects: ''relative'' to the `project_bath` 
     99   * when serving multiple projects: ''relative'' to the `project_path` 
    88100   * when serving only a single project (`-s`): the name of the project directory 
    89101 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. 
    … …  
    91103 * '''realm''': the realm name (can be anything) 
    92104 * '''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 
    93106 
    94107Examples: 
    … …  
    190203}}} 
    191204 
    192 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.) 
    193207 
    194208It is possible to use md5sum utility to generate digest-password file using such method: 
    … …  
    198212and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 
    199213 
     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 
    200242== Tips == 
    201243 
    202244=== Serving static content === 
    203245 
    204 If `tracd` is the only webserver used for the project,  
     246If `tracd` is the only web server used for the project,  
    205247it can also be used to distribute static content  
    206248(tarballs, Doxygen documentation, etc.) 
    … …  
    211253Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
    212254the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,  
    213 which in turn can be written using the relative link syntax 
    214 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`  
    215  
    216 Since 0.10, Trac supports a new `htdocs:` TracLinks  
    217 syntax for the above. With this, the example link above can be written simply  
    218 `htdocs:software-0.1.tar.gz`.  
    219  
    220 === Using apache rewrite rules === 
    221 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]. 
    222268 
    223269=== Serving a different base path than / === 
    … …  
    228274 
    229275---- 
    230 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]