Changes between Version 2 and Version 3 of TracStandalone


Ignore:
Timestamp:
04/22/15 15:39:50 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracStandalone

    v2 v3  
    1 = Tracd =
    2 
    3 Tracd 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 ==
     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
    67
    78 * 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 * 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
    910 * 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.
     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.
    1515 * 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 ==
     16   or [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
     17
     18== Usage examples
    1919
    2020A single project on port 8080. (http://localhost:8080/)
    21 {{{
     21{{{#!sh
    2222 $ tracd -p 8080 /path/to/project
    2323}}}
    24 Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
    25 {{{
     24Strictly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use the `--hostname` option.
     25{{{#!sh
    2626 $ tracd --hostname=localhost -p 8080 /path/to/project
    2727}}}
    2828With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
    29 {{{
     29{{{#!sh
    3030 $ tracd -p 8080 /path/to/project1 /path/to/project2
    3131}}}
    … …  
    3535
    3636An 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 {{{
     37{{{#!sh
    3838 $ tracd -p 8080 -e /path/to
    3939}}}
    4040
    41 To 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 
     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
    4546To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    46 {{{
     47{{{#!cmd
    4748 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
    4849 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>"
    … …  
    5354
    5455If you want tracd to start automatically when you boot Windows, do:
    55 {{{
     56{{{#!cmd
    5657 sc config tracd start= auto
    5758}}}
    … …  
    5960The spacing here is important.
    6061
    61 == Using Authentication ==
    62 
    63 Using tracd with Apache .htpasswd files:
    64 
    65 To create a .htpasswd file using htpasswd:
    66 
    67 {{{
     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{{{#!cmd
     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>"
     78net start tracd
     79}}}
     80
     81=== Option 2
     82
     83Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     84
     85=== Option 3
     86
     87also cygwin's cygrunsrv.exe can be used:
     88{{{#!sh
     89$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
     90$ net start tracd
     91}}}
     92
     93== Using Authentication
     94
     95Tracd allows you to run Trac without the need for Apache, but you can take advantage of Apache's password tools (htpasswd and htdigest) to easily create a password file in the proper format for tracd to use in authentication. (It is also possible to create the password file without htpasswd or htdigest; see below for alternatives)
     96
     97Make sure you place the generated password files on a filesystem which supports sub-second timestamps, as Trac will monitor their modified time and changes happening on a filesystem with too coarse-grained timestamp resolution (like `ext2` or `ext3` on Linux) may go undetected.
     98
     99Tracd provides support for both Basic and Digest authentication. Digest is considered more secure. The examples below use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the command line.
     100
     101The general format for using authentication is:
     102{{{#!sh
     103 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
     104}}}
     105where:
     106 * '''base_project_dir''': the base directory of the project specified as follows:
     107   * when serving multiple projects: ''relative'' to the `project_path`
     108   * when serving only a single project (`-s`): the name of the project directory
     109 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
     110 * '''password_file_path''': path to the password file
     111 * '''realm''': the realm name (can be anything)
     112 * '''project_path''': path of the project
     113
     114 * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth.  Although Basic authentication does not require a "realm", the command parser does, so the second comma is required, followed directly by the closing quote for an empty realm name.
     115
     116Examples:
     117
     118{{{#!sh
     119 $ tracd -p 8080 \
     120   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
     121}}}
     122
     123Of course, the password file can be be shared so that it is used for more than one project:
     124{{{#!sh
     125 $ tracd -p 8080 \
     126   --auth="project1,/path/to/passwordfile,mycompany.com" \
     127   --auth="project2,/path/to/passwordfile,mycompany.com" \
     128   /path/to/project1 /path/to/project2
     129}}}
     130
     131Another way to share the password file is to specify "*" for the project name:
     132{{{#!sh
     133 $ tracd -p 8080 \
     134   --auth="*,/path/to/users.htdigest,mycompany.com" \
     135   /path/to/project1 /path/to/project2
     136}}}
     137
     138=== Basic Authorization: Using a htpasswd password file
     139This section describes how to use `tracd` with Apache .htpasswd files.
     140
     141  Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to
     142  decode some htpasswd formats.  Trac source code attempt an `import crypt` first, but there
     143  is no such package for Python 2.6. Only `SHA-1` passwords (since Trac 1.0) work without this module.
     144
     145To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     146{{{#!sh
    68147 $ sudo htpasswd -c /path/to/env/.htpasswd username
    69148}}}
    70149then for additional users:
    71 {{{
     150{{{#!sh
    72151 $ sudo htpasswd /path/to/env/.htpasswd username2
    73152}}}
    74 then 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 
    79 Tracd 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 
    83 The 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 
    89 where:
    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 
    96 Example (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 }}}
    102 Of 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 
    110 Another way to share the digest file is to specify "*"
    111 for the project name:
    112 {{{
    113  $ tracd -p 8080 \
    114    --auth="*",/path/to/users.htdigest,mycompany.com \
    115    /path/to/project1 /path/to/project2
    116 }}}
    117 If 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 ==
     153
     154Then to start `tracd` run something like this:
     155{{{#!sh
     156 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     157}}}
     158
     159For example:
     160{{{#!sh
     161 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     162}}}
     163''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     164
     165=== Digest authentication: Using a htdigest password file
    120166
    121167If 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.
    122168
    123 Note 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 
    127 If you don't have Apache available, you can use this simple Python script to generate your passwords:
    128 
    129 {{{
    130 #!python
     169Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
     170
     171=== Generating Passwords Without Apache
     172
     173Basic Authorization can be accomplished via this [http://aspirine.org/htpasswd_en.html online HTTP Password generator] which also supports `SHA-1`.  Copy the generated password-hash line to the .htpasswd file on your system. Note that Windows Python lacks the "crypt" module that is the default hash type for htpasswd ; Windows Python can grok MD5 password hashes just fine and you should use MD5.
     174
     175You can use this simple Python script to generate a '''digest''' password file:
     176
     177{{{#!python
    131178from optparse import OptionParser
    132179# The md5 module is deprecated in Python 2.5
    … …  
    159206}}}
    160207
    161 Note: 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 {{{
     208Note: If you use the above script you must set the realm in the `--auth` argument to '''`trac`'''. Example usage (assuming you saved the script as trac-digest.py):
     209
     210{{{#!sh
    164211 $ python trac-digest.py -u username -p password >> c:\digest.txt
    165212 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
    166213}}}
    167214
    168 Note: 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 
    170 It is possible to use md5sum utility to generate digest-password file using such method:
     215==== Using `md5sum`
     216It is possible to use `md5sum` utility to generate digest-password file:
    171217{{{
    172  $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
    173 }}}
    174 and 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 
    180 If `tracd` is the only webserver used for the project,
     218user=
     219realm=
     220password=
     221path_to_file=
     222echo ${user}:${realm}:$(printf "${user}:${realm}:${password}" | md5sum - | sed -e 's/\s\+-//') > ${path_to_file}
     223}}}
     224
     225== Reference
     226
     227Here's the online help, as a reminder (`tracd --help`):
     228{{{
     229Usage: tracd [options] [projenv] ...
     230
     231Options:
     232  --version             show program's version number and exit
     233  -h, --help            show this help message and exit
     234  -a DIGESTAUTH, --auth=DIGESTAUTH
     235                        [projectdir],[htdigest_file],[realm]
     236  --basic-auth=BASICAUTH
     237                        [projectdir],[htpasswd_file],[realm]
     238  -p PORT, --port=PORT  the port number to bind to
     239  -b HOSTNAME, --hostname=HOSTNAME
     240                        the host name or IP address to bind to
     241  --protocol=PROTOCOL   http|scgi|ajp|fcgi
     242  -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
     243  --http10              use HTTP/1.0 protocol version instead of HTTP/1.1
     244  --http11              use HTTP/1.1 protocol version (default)
     245  -e PARENTDIR, --env-parent-dir=PARENTDIR
     246                        parent directory of the project environments
     247  --base-path=BASE_PATH
     248                        the initial portion of the request URL's "path"
     249  -r, --auto-reload     restart automatically when sources are modified
     250  -s, --single-env      only serve a single project without the project list
     251  -d, --daemonize       run in the background as a daemon
     252  --pidfile=PIDFILE     when daemonizing, file to which to write pid
     253  --umask=MASK          when daemonizing, file mode creation mask to use, in
     254                        octal notation (default 022)
     255  --group=GROUP         the group to run as
     256  --user=USER           the user to run as
     257}}}
     258
     259Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
     260
     261== Tips
     262
     263=== Serving static content
     264
     265If `tracd` is the only web server used for the project,
    181266it can also be used to distribute static content
    182267(tarballs, Doxygen documentation, etc.)
    … …  
    187272Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    188273the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    189 which in turn can be written using the relative link syntax
    190 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
    191 
    192 Since 0.10, Trac supports a new `htdocs:` TracLinks
    193 syntax 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 ===
    197 In 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 / ===
     274which 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).
     275
     276=== Using tracd behind a proxy
     277
     278In some situations when you choose to use tracd behind Apache or another web server.
     279
     280In 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.
     281
     282If 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.
     283
     284See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
     285
     286=== Authentication for tracd behind a proxy
     287It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. There is some discussion about this in [trac:#9206].
     288
     289Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
     290
     291First we bring tracd into Apache's location namespace.
     292
     293{{{#!apache
     294<Location /project/proxified>
     295        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com
     296        Require ldap-user somespecificusertoo
     297        ProxyPass http://localhost:8101/project/proxified/
     298        # Turns out we don't really need complicated RewriteRules here at all
     299        RequestHeader set REMOTE_USER %{REMOTE_USER}s
     300</Location>
     301}}}
     302
     303Then we need a single file plugin to recognize HTTP_REMOTE_USER header as valid authentication source. HTTP headers like '''HTTP_FOO_BAR''' will get converted to '''Foo-Bar''' during processing. Name it something like '''remote-user-auth.py''' and drop it into '''proxified/plugins''' directory:
     304{{{#!python
     305from trac.core import *
     306from trac.config import BoolOption
     307from trac.web.api import IAuthenticator
     308
     309class MyRemoteUserAuthenticator(Component):
     310
     311    implements(IAuthenticator)
     312
     313    obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false',
     314               """Whether the 'Remote-User:' HTTP header is to be trusted for user logins
     315                (''since ??.??').""")
     316
     317    def authenticate(self, req):
     318        if self.obey_remote_user_header and req.get_header('Remote-User'):
     319            return req.get_header('Remote-User')
     320        return None
     321
     322}}}
     323
     324Add this new parameter to your TracIni:
     325{{{#!ini
     326[trac]
     327...
     328obey_remote_user_header = true
     329...
     330}}}
     331
     332Run tracd:
     333{{{#!sh
     334tracd -p 8101 -r -s proxified --base-path=/project/proxified
     335}}}
     336
     337Note that if you want to install this plugin for all projects, you have to put it in your [TracPlugins#Plugindiscovery global plugins_dir] and enable it in your global trac.ini.
     338
     339Global config (e.g. `/srv/trac/conf/trac.ini`):
     340{{{#!ini
     341[components]
     342remote-user-auth.* = enabled
     343[inherit]
     344plugins_dir = /srv/trac/plugins
     345[trac]
     346obey_remote_user_header = true
     347}}}
     348
     349Environment config (e.g. `/srv/trac/envs/myenv`):
     350{{{#!ini
     351[inherit]
     352file = /srv/trac/conf/trac.ini
     353}}}
     354
     355=== Serving a different base path than /
    200356Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
    201 {{{
     357{{{#!sh
    202358 $ tracd --base-path=/some/path
    203359}}}
    204360
    205361----
    206 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]
     362See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]