Changes between Initial Version and Version 1 of TracStandalone

Show
Ignore:
Timestamp:
02/28/09 05:41:39 (5 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 
     11== Cons == 
     12 
     13 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD. 
     14 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 
     15   or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. 
     16 
     17== Usage examples == 
     18 
     19A single project on port 8080. (http://localhost:8080/) 
     20{{{ 
     21 $ tracd -p 8080 /path/to/project 
     22}}} 
     23Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option. 
     24{{{ 
     25 $ tracd --hostname=localhost -p 8080 /path/to/project 
     26}}} 
     27With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 
     28{{{ 
     29 $ tracd -p 8080 /path/to/project1 /path/to/project2 
     30}}} 
     31 
     32You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the 
     33different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project. 
     34 
     35An 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: 
     36{{{ 
     37 $ tracd -p 8080 -e /path/to 
     38}}} 
     39 
     40To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background. 
     41 
     42 
     43== Using Authentication == 
     44 
     45Using tracd with Apache .htpasswd files: 
     46 
     47To create a .htpasswd file using htpasswd: 
     48 
     49{{{ 
     50sudo htpasswd -c /path/to/env/.htpasswd username 
     51}}} 
     52then for additional users: 
     53{{{ 
     54sudo htpasswd /var/www/html/.htpasswd-users username2 
     55}}} 
     56then for starting the tracd: 
     57{{{ 
     58tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 
     59}}} 
     60 
     61 
     62Tracd 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.) 
     63 
     64  ''Support for Basic authentication was added in version 0.9.'' 
     65 
     66The general format for using authentication is: 
     67 
     68{{{ 
     69 $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path 
     70}}} 
     71 
     72where: 
     73 
     74 * '''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 
     75 * '''password_file_path''' path of the password file 
     76 * '''realm''' realm 
     77 * '''project_path''' path of the project 
     78 
     79Example: 
     80 
     81{{{ 
     82 $ tracd -p 8080 \ 
     83   --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 
     84}}} 
     85Of course, the digest file can be be shared so that it is used for more than one project: 
     86{{{ 
     87 $ tracd -p 8080 \ 
     88   --auth=project1,/path/to/users.htdigest,mycompany.com \ 
     89   --auth=project2,/path/to/users.htdigest,mycompany.com \ 
     90   /path/to/project1 /path/to/project2 
     91}}} 
     92 
     93Another way to share the digest file is to specify "*" 
     94for the project name: 
     95{{{ 
     96 $ tracd -p 8080 \ 
     97   --auth=*,/path/to/users.htdigest,mycompany.com \ 
     98   /path/to/project1 /path/to/project2 
     99}}} 
     100 
     101== How to set up an htdigest password file == 
     102 
     103If 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. 
     104 
     105Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
     106 
     107== Generating Passwords Without Apache == 
     108 
     109If you don't have Apache available, you can use this simple Python script to generate your passwords: 
     110 
     111{{{ 
     112#!python 
     113from optparse import OptionParser 
     114import md5 
     115 
     116# build the options 
     117usage = "usage: %prog [options]" 
     118parser = OptionParser(usage=usage) 
     119parser.add_option("-u", "--username",action="store", dest="username", type = "string", 
     120                  help="the username for whom to generate a password") 
     121parser.add_option("-p", "--password",action="store", dest="password", type = "string", 
     122                  help="the password to use") 
     123(options, args) = parser.parse_args() 
     124 
     125# check options 
     126if (options.username is None) or (options.password is None): 
     127   parser.error("You must supply both the username and password") 
     128    
     129# Generate the string to enter into the htdigest file 
     130realm = 'trac' 
     131kd = lambda x: md5.md5(':'.join(x)).hexdigest() 
     132print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 
     133}}} 
     134 
     135Note: 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): 
     136 
     137{{{ 
     138python trac-digest.py -u username -p password >> c:\digest.txt 
     139tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 
     140}}} 
     141 
     142Note: 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.) 
     143 
     144It is possible to use md5sum utility to generate digest-password file using such method: 
     145{{{ 
     146echo -e "${user}:trac:${password}\c" | md5sum - >>to-file 
     147}}} 
     148and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. You can see attachment:trac-digest-corrected.sh for detail. 
     149 
     150== Tips == 
     151 
     152=== Serving static content === 
     153 
     154If `tracd` is the only webserver used for the project,  
     155it can also be used to distribute static content  
     156(tarballs, Doxygen documentation, etc.) 
     157 
     158This static content should be put in the `$TRAC_ENV/htdocs` folder, 
     159and is accessed by URLs like `<project_URL>/chrome/site/...`. 
     160 
     161Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 
     162the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,  
     163which in turn can be written using the relative link syntax 
     164in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`  
     165 
     166The development version of Trac supports a new `htdocs:` TracLinks  
     167syntax for the above. With this, the example link above can be written simply  
     168`htdocs:software-0.1.tar.gz`.  
     169 
     170=== Using apache rewrite rules === 
     171In 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. 
     172 
     173=== Serving a different base path than / === 
     174Tracd supports serving projects with different base urls then /<project>. The parameter name to change this is 
     175{{{ 
     176tracd --base-path=/some/path 
     177}}} 
     178 
     179---- 
     180See also: TracInstall, TracCgi, TracModPython, TracGuide