Changes between Initial Version and Version 1 of TracStandalone

06/08/12 10:47:01 (10 years ago)



  • TracStandalone

    v1 v1  
     1= Tracd =
     3Tracd is a lightweight standalone Trac web server.
     4It can be used in a variety of situations, from a test or development server to a multiprocess setup behind another web server used as a load balancer.
     6== Pros ==
     8 * Fewer dependencies: You don't need to install apache or any other web-server.
     9 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]), even more so since version 0.12 where the HTTP/1.1 version of the protocol is enabled by default
     10 * 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).
     12== Cons ==
     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: [ sslwrap] can be used instead,
     16   or [ stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
     18== Usage examples ==
     20A single project on port 8080. (http://localhost:8080/)
     22 $ tracd -p 8080 /path/to/project
     24Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
     26 $ tracd --hostname=localhost -p 8080 /path/to/project
     28With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
     30 $ tracd -p 8080 /path/to/project1 /path/to/project2
     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.
     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:
     38 $ tracd -p 8080 -e /path/to
     41To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
     43== Installing as a Windows Service ==
     45=== Option 1 ===
     46To install as a Windows service, get the [ SRVANY] utility and run:
     48 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
     49 reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\\" <your tracd parameters>"
     50 net start tracd
     53'''DO NOT''' use {{{tracd.exe}}}.  Instead register {{{python.exe}}} directly with {{{}}} 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}}}.
     55If you want tracd to start automatically when you boot Windows, do:
     57 sc config tracd start= auto
     60The spacing here is important.
     62For Windows 7 User, srvany.exe may not be an option, so you can use [ WINSERV] utility and run:
     64"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\ <your tracd parameters>"
     66net start tracd
     69=== Option 2 ===
     71Use [ WindowsServiceScript], available at [ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     73== Using Authentication ==
     75Using tracd with Apache .htpasswd files:
     77To create a .htpasswd file using htpasswd:
     80 $ htpasswd -c /path/to/env/.htpasswd username
     82then for additional users:
     84 $ htpasswd /path/to/env/.htpasswd username2
     86then for starting the tracd (on windows skip the "=" after --basic-auth):
     88tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
     91 `environmentname` is the directory name of the Trac project folder, as opposed to `/fullpath/environmentname` which is the full path to the Trac project folder. See below for another example.
     93Tracd 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.)
     95  ''Support for Basic authentication was added in version 0.9.''
     97The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth):
     100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
     105 * '''base_project_dir''': the base directory of the project specified as follows:
     106   * when serving multiple projects: ''relative'' to the `project_path`
     107   * when serving only a single project (`-s`): the name of the project directory
     108 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
     109 * '''password_file_path''': path to the password file
     110 * '''realm''': the realm name (can be anything)
     111 * '''project_path''': path of the project
     116 $ tracd -p 8080 \
     117   --auth="project1,/path/to/passwordfile," /path/to/project1
     120Of course, the password file can be be shared so that it is used for more than one project:
     122 $ tracd -p 8080 \
     123   --auth="project1,/path/to/passwordfile," \
     124   --auth="project2,/path/to/passwordfile," \
     125   /path/to/project1 /path/to/project2
     128Another way to share the password file is to specify "*" for the project name:
     130 $ tracd -p 8080 \
     131   --auth="*,/path/to/users.htdigest," \
     132   /path/to/project1 /path/to/project2
     135=== Using a htpasswd password file ===
     136This section describes how to use `tracd` with Apache .htpasswd files.
     138To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     141 $ sudo htpasswd -c /path/to/env/.htpasswd username
     143then for additional users:
     145 $ sudo htpasswd /path/to/env/.htpasswd username2
     148Then to start `tracd` run something like this:
     151 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     154For example:
     157 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     160''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     162=== Using a htdigest password file ===
     164If 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.
     166Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
     168=== Generating Passwords Without Apache ===
     170If you don't have Apache available, you can use this simple Python script to generate your passwords:
     174from optparse import OptionParser
     175# The md5 module is deprecated in Python 2.5
     177    from hashlib import md5
     178except ImportError:
     179    from md5 import md5
     180realm = 'trac'
     182# build the options
     183usage = "usage: %prog [options]"
     184parser = OptionParser(usage=usage)
     185parser.add_option("-u", "--username",action="store", dest="username", type = "string",
     186                  help="the username for whom to generate a password")
     187parser.add_option("-p", "--password",action="store", dest="password", type = "string",
     188                  help="the password to use")
     189parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     190                  help="the realm in which to create the digest")
     191(options, args) = parser.parse_args()
     193# check options
     194if (options.username is None) or (options.password is None):
     195   parser.error("You must supply both the username and password")
     196if (options.realm is not None):
     197   realm = options.realm
     199# Generate the string to enter into the htdigest file
     200kd = lambda x: md5(':'.join(x)).hexdigest()
     201print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
     204Note: 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
     207 $ python -u username -p password >> c:\digest.txt
     208 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     212Note: 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). Make sure to use -m option for it.  If you do not have Apache, [trac:source:/tags/trac-0.11/contrib/] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
     214It is possible to use md5sum utility to generate digest-password file using such method:
     216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
     218and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
     220== Tips ==
     222=== Serving static content ===
     224If `tracd` is the only web server used for the project,
     225it can also be used to distribute static content
     226(tarballs, Doxygen documentation, etc.)
     228This static content should be put in the `$TRAC_ENV/htdocs` folder,
     229and is accessed by URLs like `<project_URL>/chrome/site/...`.
     231Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
     232the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     233which in turn can be written as `htdocs:software-0.1.tar.gz` (TracLinks syntax) or `[/<project_name>/chrome/site/software-0.1.tar.gz]` (relative link syntax).
     235 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
     237=== Using apache rewrite rules ===
     238In 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.
     240=== Serving a different base path than / ===
     241Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     243 $ tracd --base-path=/some/path
     247See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]