Changes between Initial Version and Version 1 of TracStandalone

12/19/08 06:07:36 (14 years ago)



  • TracStandalone

    v1 v1  
     1= Tracd =
     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].
     5== Pros ==
     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).
     11== Cons ==
     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: [ sslwrap] can be used instead,
     15   or [ stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
     17== Usage examples ==
     19A single project on port 8080. (http://localhost:8080/)
     21 $ tracd -p 8080 /path/to/project
     23Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
     25 $ tracd --hostname=localhost -p 8080 /path/to/project
     27With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
     29 $ tracd -p 8080 /path/to/project1 /path/to/project2
     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.
     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:
     37 $ tracd -p 8080 -e /path/to
     40To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
     42When running as a Windows service using a utility such as [ SRVANY], stopping or restarting the service will also leave a Python process running -- restart the system instead.
     45== Using Authentication ==
     47Using tracd with Apache .htpasswd files:
     49To create a .htpasswd file using htpasswd:
     52sudo htpasswd -c /path/to/env/.htpasswd username
     54then for additional users:
     56sudo htpasswd /path/to/env/.htpasswd username2
     58then for starting the tracd:
     60tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
     64Tracd 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.)
     66  ''Support for Basic authentication was added in version 0.9.''
     68The general format for using authentication is:
     71 $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
     76 * '''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
     77 * '''password_file_path''' path of the password file
     78 * '''realm''' realm
     79 * '''project_path''' path of the project
     84 $ tracd -p 8080 \
     85   --auth=project1,/path/to/users.htdigest, /path/to/project1
     87Of course, the digest file can be be shared so that it is used for more than one project:
     89 $ tracd -p 8080 \
     90   --auth=project1,/path/to/users.htdigest, \
     91   --auth=project2,/path/to/users.htdigest, \
     92   /path/to/project1 /path/to/project2
     95Another way to share the digest file is to specify "*"
     96for the project name:
     98 $ tracd -p 8080 \
     99   --auth="*",/path/to/users.htdigest, \
     100   /path/to/project1 /path/to/project2
     102If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
     104== How to set up an htdigest password file ==
     106If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [ 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.
     108Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
     110== Generating Passwords Without Apache ==
     112If you don't have Apache available, you can use this simple Python script to generate your passwords:
     116from optparse import OptionParser
     117# The md5 module is deprecated in Python 2.5
     119    from hashlib import md5
     120except ImportError:
     121    from md5 import md5
     122realm = 'trac'
     124# build the options
     125usage = "usage: %prog [options]"
     126parser = OptionParser(usage=usage)
     127parser.add_option("-u", "--username",action="store", dest="username", type = "string",
     128                  help="the username for whom to generate a password")
     129parser.add_option("-p", "--password",action="store", dest="password", type = "string",
     130                  help="the password to use")
     131parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     132                  help="the realm in which to create the digest")
     133(options, args) = parser.parse_args()
     135# check options
     136if (options.username is None) or (options.password is None):
     137   parser.error("You must supply both the username and password")
     138if (options.realm is not None):
     139   realm = options.realm
     141# Generate the string to enter into the htdigest file
     142kd = lambda x: md5(':'.join(x)).hexdigest()
     143print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
     146Note: 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
     149python -u username -p password >> c:\digest.txt
     150tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     153Note: 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/] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
     155It is possible to use md5sum utility to generate digest-password file using such method:
     157echo -e "${user}:trac:${password}\c" | md5sum - >>to-file
     159and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. You can see for detail.
     161== Tips ==
     163=== Serving static content ===
     165If `tracd` is the only webserver used for the project,
     166it can also be used to distribute static content
     167(tarballs, Doxygen documentation, etc.)
     169This static content should be put in the `$TRAC_ENV/htdocs` folder,
     170and is accessed by URLs like `<project_URL>/chrome/site/...`.
     172Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
     173the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     174which in turn can be written using the relative link syntax
     175in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
     177The development version of Trac supports a new `htdocs:` TracLinks
     178syntax for the above. With this, the example link above can be written simply
     181=== Using apache rewrite rules ===
     182In 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.
     184=== Serving a different base path than / ===
     185Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     187tracd --base-path=/some/path
     191See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]