Changes between Initial Version and Version 1 of TracStandalone

Show
Ignore:
Timestamp:
01/05/12 22:59:04 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v1  
     1= Tracd = 
     2 
     3Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script]. 
     4 
     5== Pros == 
     6 
     7 * 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 * 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` 
     11 
     12== Cons == 
     13 
     14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD. 
     15 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 
     16   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. 
     17 
     18== Usage examples == 
     19 
     20A single project on port 8080. (http://localhost:8080/) 
     21{{{ 
     22 $ tracd -p 8080 /path/to/project 
     23}}} 
     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}}} 
     28With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 
     29{{{ 
     30 $ tracd -p 8080 /path/to/project1 /path/to/project2 
     31}}} 
     32 
     33You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the 
     34different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project. 
     35 
     36An alternative way to serve multiple projects is to specify a parent directory in which each subdirectory is a Trac project, using the `-e` option. The example above could be rewritten: 
     37{{{ 
     38 $ tracd -p 8080 -e /path/to 
     39}}} 
     40 
     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 
     61== Using Authentication == 
     62 
     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.) 
     80 
     81  ''Support for Basic authentication was added in version 0.9.'' 
     82 
     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}}} 
     102Of 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 
     110Another way to share the digest file is to specify "*" 
     111for the project name: 
     112{{{ 
     113 $ tracd -p 8080 \ 
     114   --auth="*",/path/to/users.htdigest,mycompany.com \ 
     115   /path/to/project1 /path/to/project2 
     116}}} 
     117If 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 == 
     120 
     121If 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. 
     122 
     123Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
     124 
     125== Generating Passwords Without Apache == 
     126 
     127If you don't have Apache available, you can use this simple Python script to generate your passwords: 
     128 
     129{{{ 
     130#!python 
     131from optparse import OptionParser 
     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' 
     138 
     139# build the options 
     140usage = "usage: %prog [options]" 
     141parser = OptionParser(usage=usage) 
     142parser.add_option("-u", "--username",action="store", dest="username", type = "string", 
     143                  help="the username for whom to generate a password") 
     144parser.add_option("-p", "--password",action="store", dest="password", type = "string", 
     145                  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") 
     148(options, args) = parser.parse_args() 
     149 
     150# check options 
     151if (options.username is None) or (options.password is None): 
     152   parser.error("You must supply both the username and password") 
     153if (options.realm is not None): 
     154   realm = options.realm 
     155    
     156# Generate the string to enter into the htdigest file 
     157kd = lambda x: md5(':'.join(x)).hexdigest() 
     158print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 
     159}}} 
     160 
     161Note: If you use the above script you must use the --auth option to tracd, not --basic-auth, and you must set the realm in the --auth value to 'trac' (without the quotes). Example usage (assuming you saved the script as trac-digest.py): 
     162 
     163{{{ 
     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'. 
     175 
     176== Tips == 
     177 
     178=== Serving static content === 
     179 
     180If `tracd` is the only webserver used for the project,  
     181it can also be used to distribute static content  
     182(tarballs, Doxygen documentation, etc.) 
     183 
     184This static content should be put in the `$TRAC_ENV/htdocs` folder, 
     185and is accessed by URLs like `<project_URL>/chrome/site/...`. 
     186 
     187Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
     188the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,  
     189which in turn can be written using the relative link syntax 
     190in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`  
     191 
     192Since 0.10, Trac supports a new `htdocs:` TracLinks  
     193syntax 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 === 
     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 
     205---- 
     206See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]