Changes between Version 3 and Version 4 of TracStandalone


Ignore:
Timestamp:
11/06/10 11:32:38 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v3 v4  
    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 == 
     
    2122 $ tracd -p 8080 /path/to/project 
    2223}}} 
     24Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option. 
     25{{{ 
     26 $ tracd --hostname=localhost -p 8080 /path/to/project 
     27}}} 
    2328With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 
    2429{{{ 
     
    3439}}} 
    3540 
     41To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background. 
     42 
     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. 
     60 
    3661== Using Authentication == 
    3762 
    38 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, and omit the realm. 
     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 
     79Tracd 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.) 
    3980 
    4081  ''Support for Basic authentication was added in version 0.9.'' 
    4182 
    42 If the file `/path/to/users.htdigest` contains user accounts for project1 with the realm "mycompany.com", you'd use the following command-line to start tracd: 
    43 {{{ 
    44  $ tracd -p 8080 --auth project1,/path/to/users.htdigest,mycompany.com /path/to/project1 
    45 }}} 
    46  
    47 '''Note''': the project "name" passed to the `--auth` option is the base name of the project environment directory. 
    48  
     83The 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 
     89where: 
     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 
     96Example (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}}} 
    49102Of course, the digest file can be be shared so that it is used for more than one project: 
    50103{{{ 
    51104 $ tracd -p 8080 \ 
    52    --auth project1,/path/to/users.htdigest,mycompany.com \ 
    53    --auth project2,/path/to/users.htdigest,mycompany.com \ 
     105   --auth=project1,/path/to/users.htdigest,mycompany.com \ 
     106   --auth=project2,/path/to/users.htdigest,mycompany.com \ 
    54107   /path/to/project1 /path/to/project2 
    55108}}} 
     
    59112{{{ 
    60113 $ tracd -p 8080 \ 
    61    --auth *,/path/to/users.htdigest,mycompany.com \ 
     114   --auth="*",/path/to/users.htdigest,mycompany.com \ 
    62115   /path/to/project1 /path/to/project2 
    63116}}} 
     117If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name 
    64118 
    65119== How to set up an htdigest password file == 
     
    74128 
    75129{{{ 
     130#!python 
    76131from optparse import OptionParser 
    77 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' 
    78138 
    79139# build the options 
     
    84144parser.add_option("-p", "--password",action="store", dest="password", type = "string", 
    85145                  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") 
    86148(options, args) = parser.parse_args() 
    87149 
     
    89151if (options.username is None) or (options.password is None): 
    90152   parser.error("You must supply both the username and password") 
     153if (options.realm is not None): 
     154   realm = options.realm 
    91155    
    92156# Generate the string to enter into the htdigest file 
    93 realm = 'trac' 
    94 kd = lambda x: md5.md5(':'.join(x)).hexdigest() 
     157kd = lambda x: md5(':'.join(x)).hexdigest() 
    95158print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 
    96159}}} 
     
    99162 
    100163{{{ 
    101 python trac-digest.py -u username -p password >> c:\digest.txt 
    102 python tracd --port 8000 --auth proj_name,c:\digest.txt,trac c:\path\to\proj_name 
    103 }}} 
     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'. 
    104175 
    105176== Tips == 
     
    119190in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`  
    120191 
    121 The development version of Trac supports a new `htdocs:` TracLinks  
     192Since 0.10, Trac supports a new `htdocs:` TracLinks  
    122193syntax for the above. With this, the example link above can be written simply  
    123194`htdocs:software-0.1.tar.gz`.  
    124195 
     196=== Using apache rewrite rules === 
     197In 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. 
     198 
     199=== Serving a different base path than / === 
     200Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 
     201{{{ 
     202 $ tracd --base-path=/some/path 
     203}}} 
     204 
    125205---- 
    126 See also: TracInstall, TracCgi, TracModPython, TracGuide 
    127  
    128 ---- 
    129 '''Translation:''' 
    130  * [https://opensvn.csie.org/traccgi/trac_rus/wiki/StandAloneTracForTeapot Russian] (перевод на Русский) 
     206See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]