Changes between Version 6 and Version 7 of TracStandalone


Ignore:
Timestamp:
03/18/10 20:29:12 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v6 v7  
    88 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
    99 * 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`
    1011
    1112== Cons ==
     
    4041To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
    4142
     43== Installing as a Windows Service ==
     44
     45To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
     46{{{
     47 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
     48 reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\tracd-script.py\" <your tracd parameters>"
     49 net start tracd
     50}}}
     51
     52'''DO NOT''' use {{{tracd.exe}}}.  Instead register {{{python.exe}}} directly with {{{tracd-script.py}}} as a parameter.  If you use {{{tracd.exe}}}, it will spawn the python process without SRVANY's knowledge.  This python process will survive a {{{net stop tracd}}}.
     53
     54If you want tracd to start automatically when you boot Windows, do:
     55{{{
     56 sc config tracd start= auto
     57}}}
     58
     59The spacing here is important.
    4260
    4361== Using Authentication ==
    4462
     63Using tracd with Apache .htpasswd files:
     64
     65To create a .htpasswd file using htpasswd:
     66
     67{{{
     68 $ sudo htpasswd -c /path/to/env/.htpasswd username
     69}}}
     70then for additional users:
     71{{{
     72 $ sudo htpasswd /path/to/env/.htpasswd username2
     73}}}
     74then 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
    4579Tracd 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.)
    4680
    4781  ''Support for Basic authentication was added in version 0.9.''
    4882
    49 The general format for using authentication is:
     83The general format for using authentication is (on windows skip the "=" after --auth):
    5084
    5185{{{
     
    6094 * '''project_path''' path of the project
    6195
    62 Example:
     96Example (on windows skip the "=" after --auth):
    6397
    6498{{{
     
    78112{{{
    79113 $ tracd -p 8080 \
    80    --auth=*,/path/to/users.htdigest,mycompany.com \
     114   --auth="*",/path/to/users.htdigest,mycompany.com \
    81115   /path/to/project1 /path/to/project2
    82116}}}
     117If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
    83118
    84119== How to set up an htdigest password file ==
     
    95130#!python
    96131from optparse import OptionParser
    97 import md5
     132# The md5 module is deprecated in Python 2.5
     133try:
     134    from hashlib import md5
     135except ImportError:
     136    from md5 import md5
     137realm = 'trac'
    98138
    99139# build the options
     
    104144parser.add_option("-p", "--password",action="store", dest="password", type = "string",
    105145                  help="the password to use")
     146parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     147                  help="the realm in which to create the digest")
    106148(options, args) = parser.parse_args()
    107149
     
    109151if (options.username is None) or (options.password is None):
    110152   parser.error("You must supply both the username and password")
     153if (options.realm is not None):
     154   realm = options.realm
    111155   
    112156# Generate the string to enter into the htdigest file
    113 realm = 'trac'
    114 kd = lambda x: md5.md5(':'.join(x)).hexdigest()
     157kd = lambda x: md5(':'.join(x)).hexdigest()
    115158print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
    116159}}}
     
    119162
    120163{{{
    121 python trac-digest.py -u username -p password >> c:\digest.txt
    122 tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
    123 }}}
    124 
    125 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).
     164 $ python trac-digest.py -u username -p password >> c:\digest.txt
     165 $ tracd --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.)
     169
     170It is possible to use md5sum utility to generate digest-password file using such method:
     171{{{
     172 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
     173}}}
     174and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
    126175
    127176== Tips ==
     
    141190in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
    142191
    143 The development version of Trac supports a new `htdocs:` TracLinks
     192Since 0.10, Trac supports a new `htdocs:` TracLinks
    144193syntax for the above. With this, the example link above can be written simply
    145194`htdocs:software-0.1.tar.gz`.
     
    149198
    150199=== Serving a different base path than / ===
    151 Tracd supports serving projects with different base urls then /<project>. The parameter name to change this is
    152 {{{
    153 tracd --base-path=/some/path
     200Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     201{{{
     202 $ tracd --base-path=/some/path
    154203}}}
    155204
    156205----
    157 See also: TracInstall, TracCgi, TracModPython, TracGuide
     206See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]