Changes between Initial Version and Version 1 of TracStandalone


Ignore:
Timestamp:
21/10/10 12:16:33 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v1  
     1= Tracd =
     2
     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.
     5
     6== Pros ==
     7
     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).
     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
     45=== Option 1 ===
     46To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
     47{{{
     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\tracd-script.py\" <your tracd parameters>"
     50 net start tracd
     51}}}
     52
     53'''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}}}.
     54
     55If you want tracd to start automatically when you boot Windows, do:
     56{{{
     57 sc config tracd start= auto
     58}}}
     59
     60The spacing here is important.
     61
     62{{{#!div
     63Once the service is installed, it might be simpler to run the Registry Editor rather than use the `reg add` command documented above.  Navigate to:[[BR]]
     64`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters`
     65
     66Three (string) parameters are provided:
     67||!AppDirectory ||C:\Python26\ ||
     68||Application ||python.exe ||
     69||!AppParameters ||scripts\tracd-script.py -p 8080 ... ||
     70
     71Note that, if the !AppDirectory is set as above, the paths of the executable ''and'' of the script name and parameter values are relative to the directory.  This makes updating Python a little simpler because the change can be limited, here, to a single point.
     72(This is true for the path to the .htpasswd file, as well, despite the documentation calling out the /full/path/to/htpasswd; however, you may not wish to store that file under the Python directory.)
     73}}}
     74
     75For Windows 7 User, srvany.exe may not be an option, so you can use [http://www.google.com/search?q=winserv.exe WINSERV] utility and run:
     76{{{
     77"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd-script.py <your tracd parameters>"
     78
     79net start tracd
     80}}}
     81
     82=== Option 2 ===
     83
     84Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     85
     86== Using Authentication ==
     87
     88Tracd 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.)
     89
     90
     91The general format for using authentication is:
     92{{{
     93 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
     94}}}
     95
     96where:
     97
     98 * '''base_project_dir''': the base directory of the project specified as follows:
     99   * when serving multiple projects: ''relative'' to the `project_path`
     100   * when serving only a single project (`-s`): the name of the project directory
     101 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
     102 * '''password_file_path''': path to the password file
     103 * '''realm''': the realm name (can be anything)
     104 * '''project_path''': path of the project
     105 * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth
     106
     107Examples:
     108
     109{{{
     110 $ tracd -p 8080 \
     111   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
     112}}}
     113
     114Of course, the password file can be be shared so that it is used for more than one project:
     115{{{
     116 $ tracd -p 8080 \
     117   --auth="project1,/path/to/passwordfile,mycompany.com" \
     118   --auth="project2,/path/to/passwordfile,mycompany.com" \
     119   /path/to/project1 /path/to/project2
     120}}}
     121
     122Another way to share the password file is to specify "*" for the project name:
     123{{{
     124 $ tracd -p 8080 \
     125   --auth="*,/path/to/users.htdigest,mycompany.com" \
     126   /path/to/project1 /path/to/project2
     127}}}
     128
     129=== Using a htpasswd password file ===
     130This section describes how to use `tracd` with Apache .htpasswd files.
     131
     132To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     133
     134{{{
     135 $ sudo htpasswd -c /path/to/env/.htpasswd username
     136}}}
     137then for additional users:
     138{{{
     139 $ sudo htpasswd /path/to/env/.htpasswd username2
     140}}}
     141
     142Then to start `tracd` run something like this:
     143
     144{{{
     145 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     146}}}
     147
     148For example:
     149
     150{{{
     151 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     152}}}
     153
     154''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     155
     156=== Using a htdigest password file ===
     157
     158If 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.
     159
     160Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
     161
     162=== Generating Passwords Without Apache ===
     163
     164If you don't have Apache available, you can use this simple Python script to generate your passwords:
     165
     166{{{
     167#!python
     168from optparse import OptionParser
     169# The md5 module is deprecated in Python 2.5
     170try:
     171    from hashlib import md5
     172except ImportError:
     173    from md5 import md5
     174realm = 'trac'
     175
     176# build the options
     177usage = "usage: %prog [options]"
     178parser = OptionParser(usage=usage)
     179parser.add_option("-u", "--username",action="store", dest="username", type = "string",
     180                  help="the username for whom to generate a password")
     181parser.add_option("-p", "--password",action="store", dest="password", type = "string",
     182                  help="the password to use")
     183parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     184                  help="the realm in which to create the digest")
     185(options, args) = parser.parse_args()
     186
     187# check options
     188if (options.username is None) or (options.password is None):
     189   parser.error("You must supply both the username and password")
     190if (options.realm is not None):
     191   realm = options.realm
     192   
     193# Generate the string to enter into the htdigest file
     194kd = lambda x: md5(':'.join(x)).hexdigest()
     195print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
     196}}}
     197
     198Note: 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):
     199
     200{{{
     201 $ python trac-digest.py -u username -p password >> c:\digest.txt
     202 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     203}}}
     204
     205
     206Note: 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/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
     207
     208It is possible to use md5sum utility to generate digest-password file using such method:
     209{{{
     210 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
     211}}}
     212and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
     213
     214== Reference ==
     215
     216Here's the online help, as a reminder (`tracd --help`):
     217{{{
     218Usage: tracd [options] [projenv] ...
     219
     220Options:
     221  --version             show program's version number and exit
     222  -h, --help            show this help message and exit
     223  -a DIGESTAUTH, --auth=DIGESTAUTH
     224                        [projectdir],[htdigest_file],[realm]
     225  --basic-auth=BASICAUTH
     226                        [projectdir],[htpasswd_file],[realm]
     227  -p PORT, --port=PORT  the port number to bind to
     228  -b HOSTNAME, --hostname=HOSTNAME
     229                        the host name or IP address to bind to
     230  --protocol=PROTOCOL   http|scgi|ajp
     231  -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
     232  --http10              use HTTP/1.0 protocol version (default)
     233  --http11              use HTTP/1.1 protocol version instead of HTTP/1.0
     234  -e PARENTDIR, --env-parent-dir=PARENTDIR
     235                        parent directory of the project environments
     236  --base-path=BASE_PATH
     237                        the initial portion of the request URL's "path"
     238  -r, --auto-reload     restart automatically when sources are modified
     239  -s, --single-env      only serve a single project without the project list
     240}}}
     241
     242== Tips ==
     243
     244=== Serving static content ===
     245
     246If `tracd` is the only web server used for the project,
     247it can also be used to distribute static content
     248(tarballs, Doxygen documentation, etc.)
     249
     250This static content should be put in the `$TRAC_ENV/htdocs` folder,
     251and is accessed by URLs like `<project_URL>/chrome/site/...`.
     252
     253Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
     254the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     255which 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).
     256
     257 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
     258
     259=== Using tracd behind a proxy
     260
     261In some situations when you choose to use tracd behind Apache or another web server.
     262
     263In this situation, 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.
     264
     265If you're using the AJP protocol to connect with `tracd` (which is possible if you have flup installed), then you might experience problems with double quoting. Consider adding the `--unquote` parameter.
     266
     267See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
     268
     269=== Serving a different base path than / ===
     270Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     271{{{
     272 $ tracd --base-path=/some/path
     273}}}
     274
     275----
     276See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]