Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
08/24/22 16:34:38 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracStandalone

    v1 v2  
    1 ** Note: this page documents the version 1.0 of Trac, see [[0.12/TracStandalone]] if you need the previous version **
    2 = Tracd =
     1= Tracd
    32
    43Tracd is a lightweight standalone Trac web server.
    54It 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.
    65
    7 == Pros ==
     6== Pros
    87
    98 * Fewer dependencies: You don't need to install apache or any other web-server.
    … …  
    1110 * 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).
    1211
    13 == Cons ==
     12== Cons
    1413
    1514 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd.
    1615 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
    17    or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
    18 
    19 == 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
    2019
    2120A single project on port 8080. (http://localhost:8080/)
    22 {{{
     21{{{#!sh
    2322 $ tracd -p 8080 /path/to/project
    2423}}}
    25 Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
    26 {{{
     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
    2726 $ tracd --hostname=localhost -p 8080 /path/to/project
    2827}}}
    2928With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
    30 {{{
     29{{{#!sh
    3130 $ tracd -p 8080 /path/to/project1 /path/to/project2
    3231}}}
    … …  
    3635
    3736An 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 {{{
     37{{{#!sh
    3938 $ tracd -p 8080 -e /path/to
    4039}}}
    4140
    42 To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
    43 
    44 == Installing as a Windows Service ==
    45 
    46 === Option 1 ===
    47 To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    48 {{{
     41There is support for the HTTPS protocol (//Since 1.3.4//). Specify the path to the PEM certificate file and keyfile using the `--certfile` and `--keyfile` options. You can specify just the `--certfile` option if you have a [https://docs.python.org/2/library/ssl.html#combined-key-and-certificate combined key and certificate].
     42
     43To exit the server on Windows, be sure to use `CTRL-BREAK` -- using `CTRL-C` will leave a Python process running in the background.
     44
     45== Installing as a Windows Service
     46
     47=== Option 1
     48To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run:
     49{{{#!cmd
    4950 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
    50  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>"
     51 reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\tracd.exe\" <your tracd parameters>"
    5152 net start tracd
    5253}}}
    5354
    54 '''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}}}.
     55{{{#!div style="border: 1pt dotted; margin: 1em;"
     56**Attention:** Do not use `tracd.exe` directly.  Instead register `python.exe` directly with `tracd.exe` 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`.
     57}}}
    5558
    5659If you want tracd to start automatically when you boot Windows, do:
    57 {{{
     60{{{#!cmd
    5861 sc config tracd start= auto
    5962}}}
    … …  
    6669
    6770Three (string) parameters are provided:
    68 ||!AppDirectory ||C:\Python26\ ||
     71||!AppDirectory ||C:\Python27\ ||
    6972||Application ||python.exe ||
    70 ||!AppParameters ||scripts\tracd-script.py -p 8080 ... ||
     73||!AppParameters ||scripts\tracd.exe -p 8080 ... ||
    7174
    7275Note 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.
    … …  
    7477}}}
    7578
    76 For 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:
    77 {{{
    78 "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>"
    79 
     79For Windows 7 User, srvany.exe may not be an option, so you can use [https://www.google.com/search?q=winserv.exe WINSERV] utility and run:
     80{{{#!cmd
     81"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd.exe <your tracd parameters>"
    8082net start tracd
    8183}}}
    8284
    83 === Option 2 ===
    84 
    85 Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    86 
    87 === Option 3 ===
     85=== Option 2
     86
     87Use [https://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [https://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     88
     89=== Option 3
    8890
    8991also cygwin's cygrunsrv.exe can be used:
    90 {{{
     92{{{#!sh
    9193$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
    9294$ net start tracd
    9395}}}
    9496
    95 == Using Authentication ==
     97== Using Authentication
     98
     99Tracd 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)
     100
     101{{{#!div style="border: 1pt dotted; margin: 1em"
     102**Attention:** Make 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, or HFS+ on OSX).
     103}}}
    96104
    97105Tracd 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.
    98106
    99107The general format for using authentication is:
    100 {{{
     108{{{#!sh
    101109 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    102110}}}
    … …  
    114122Examples:
    115123
    116 {{{
     124{{{#!sh
    117125 $ tracd -p 8080 \
    118126   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
    … …  
    120128
    121129Of course, the password file can be be shared so that it is used for more than one project:
    122 {{{
     130{{{#!sh
    123131 $ tracd -p 8080 \
    124132   --auth="project1,/path/to/passwordfile,mycompany.com" \
    … …  
    128136
    129137Another way to share the password file is to specify "*" for the project name:
    130 {{{
     138{{{#!sh
    131139 $ tracd -p 8080 \
    132140   --auth="*,/path/to/users.htdigest,mycompany.com" \
    … …  
    134142}}}
    135143
    136 === Basic Authorization: Using a htpasswd password file ===
     144=== Basic Authorization: Using a htpasswd password file
    137145This section describes how to use `tracd` with Apache .htpasswd files.
    138146
    139   Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to
    140   decode some htpasswd formats.  Trac source code attempt an `import crypt` first, but there
    141   is no such package for Python 2.6. Only `SHA-1` passwords (since Trac 1.0) work without this module.
     147  Note: On Windows It is necessary to install the [https://pypi.python.org/pypi/passlib passlib]
     148  package in order to decode some htpasswd formats. Only `SHA-1` passwords (since Trac 1.0)
     149  work without this module.
    142150
    143151To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    144 {{{
     152{{{#!sh
    145153 $ sudo htpasswd -c /path/to/env/.htpasswd username
    146154}}}
    147155then for additional users:
    148 {{{
     156{{{#!sh
    149157 $ sudo htpasswd /path/to/env/.htpasswd username2
    150158}}}
    151159
    152160Then to start `tracd` run something like this:
    153 {{{
    154  $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     161{{{#!sh
     162 $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project
    155163}}}
    156164
    157165For example:
    158 {{{
    159  $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     166{{{#!sh
     167 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
    160168}}}
    161169''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    162170
    163 === Digest authentication: Using a htdigest password file ===
    164 
    165 If 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.
     171=== Digest authentication: Using a htdigest password file
     172
     173If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [https://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.
    166174
    167175Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
    168176
    169 === Generating Passwords Without Apache ===
    170 
    171 Basic 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.
    172 
    173 You can use this simple Python script to generate a '''digest''' password file:
    174 
    175 {{{
    176 #!python
    177 from optparse import OptionParser
    178 # The md5 module is deprecated in Python 2.5
    179 try:
    180     from hashlib import md5
    181 except ImportError:
    182     from md5 import md5
    183 realm = 'trac'
    184 
    185 # build the options
    186 usage = "usage: %prog [options]"
    187 parser = OptionParser(usage=usage)
    188 parser.add_option("-u", "--username",action="store", dest="username", type = "string",
    189                   help="the username for whom to generate a password")
    190 parser.add_option("-p", "--password",action="store", dest="password", type = "string",
    191                   help="the password to use")
    192 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
    193                   help="the realm in which to create the digest")
    194 (options, args) = parser.parse_args()
    195 
    196 # check options
    197 if (options.username is None) or (options.password is None):
    198    parser.error("You must supply both the username and password")
    199 if (options.realm is not None):
    200    realm = options.realm
    201    
    202 # Generate the string to enter into the htdigest file
    203 kd = lambda x: md5(':'.join(x)).hexdigest()
    204 print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
    205 }}}
    206 
    207 Note: 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):
    208 
    209 {{{
    210  $ python trac-digest.py -u username -p password >> c:\digest.txt
    211  $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     177=== Generating Passwords Without Apache
     178
     179Basic 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.
     180
     181Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
     182{{{#!sh
     183$ ./contrib/htpasswd.py -cb htpasswd user1 user1
     184$ ./contrib/htpasswd.py -b htpasswd user2 user2
     185}}}
     186
     187{{{#!sh
     188$ ./contrib/htdigest.py -cb htdigest trac user1 user1
     189$ ./contrib/htdigest.py -b htdigest trac user2 user2
    212190}}}
    213191
    214192==== Using `md5sum`
    215193It is possible to use `md5sum` utility to generate digest-password file:
    216 {{{
     194{{{#!sh
    217195user=
    218196realm=
    … …  
    222200}}}
    223201
    224 == Reference ==
    225 
    226 Here's the online help, as a reminder (`tracd --help`):
     202== Reference
     203
     204Here's the online help, as a reminder (`tracd -h` or `tracd --help`):
    227205{{{
    228 Usage: tracd [options] [projenv] ...
    229 
    230 Options:
     206usage: tracd [-h] [--version] [-e PARENTDIR | -s]
     207             [-a DIGESTAUTH | --basic-auth BASICAUTH] [-p PORT] [-b HOSTNAME]
     208             [--protocol {http,https,scgi,ajp,fcgi}] [--certfile CERTFILE]
     209             [--keyfile KEYFILE] [-q] [--base-path BASE_PATH]
     210             [--http10 | --http11] [-r | -d] [--pidfile PIDFILE]
     211             [--umask MASK] [--group GROUP] [--user USER]
     212             [envs [envs ...]]
     213
     214positional arguments:
     215  envs                  path of the project environment(s)
     216
     217optional arguments:
     218  -h, --help            show this help message and exit
    231219  --version             show program's version number and exit
    232   -h, --help            show this help message and exit
    233   -a DIGESTAUTH, --auth=DIGESTAUTH
     220  -e PARENTDIR, --env-parent-dir PARENTDIR
     221                        parent directory of the project environments
     222  -s, --single-env      only serve a single project without the project list
     223  -a DIGESTAUTH, --auth DIGESTAUTH
    234224                        [projectdir],[htdigest_file],[realm]
    235   --basic-auth=BASICAUTH
     225  --basic-auth BASICAUTH
    236226                        [projectdir],[htpasswd_file],[realm]
    237   -p PORT, --port=PORT  the port number to bind to
    238   -b HOSTNAME, --hostname=HOSTNAME
     227  -p PORT, --port PORT  the port number to bind to
     228  -b HOSTNAME, --hostname HOSTNAME
    239229                        the host name or IP address to bind to
    240   --protocol=PROTOCOL   http|scgi|ajp|fcgi
    241   -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
    242   --http10              use HTTP/1.0 protocol version instead of HTTP/1.1
    243   --http11              use HTTP/1.1 protocol version (default)
    244   -e PARENTDIR, --env-parent-dir=PARENTDIR
    245                         parent directory of the project environments
    246   --base-path=BASE_PATH
     230  --protocol {http,https,scgi,ajp,fcgi}
     231                        the server protocol (default: http)
     232  --certfile CERTFILE   PEM certificate file for HTTPS
     233  --keyfile KEYFILE     PEM key file for HTTPS
     234  -q, --unquote         unquote PATH_INFO (may be needed when using the ajp
     235                        protocol)
     236  --base-path BASE_PATH
    247237                        the initial portion of the request URL's "path"
     238  --http10              use HTTP/1.0 protocol instead of HTTP/1.1
     239  --http11              use HTTP/1.1 protocol (default)
    248240  -r, --auto-reload     restart automatically when sources are modified
    249   -s, --single-env      only serve a single project without the project list
    250241  -d, --daemonize       run in the background as a daemon
    251   --pidfile=PIDFILE     when daemonizing, file to which to write pid
    252   --umask=MASK          when daemonizing, file mode creation mask to use, in
    253                         octal notation (default 022)
    254   --group=GROUP         the group to run as
    255   --user=USER           the user to run as
     242  --pidfile PIDFILE     file to write pid when daemonizing
     243  --umask MASK          when daemonizing, file mode creation mask to use, in
     244                        octal notation (default: 022)
     245  --group GROUP         the group to run as
     246  --user USER           the user to run as
    256247}}}
    257248
    258249Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
    259250
    260 == Tips ==
    261 
    262 === Serving static content ===
    263 
    264 If `tracd` is the only web server used for the project, 
    265 it can also be used to distribute static content 
     251== Tips
     252
     253=== Serving static content
     254
     255If `tracd` is the only web server used for the project,
     256it can also be used to distribute static content
    266257(tarballs, Doxygen documentation, etc.)
    267258
    … …  
    270261
    271262Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    272 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    273 which 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).
    274 
    275  ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
     263the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     264which 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).
    276265
    277266=== Using tracd behind a proxy
    … …  
    286275
    287276=== Authentication for tracd behind a proxy
    288 It is convenient to provide central external authentication to your tracd instances, instead of using {{{--basic-auth}}}. There is some discussion about this in #9206.
     277It 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].
    289278
    290279Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
    … …  
    292281First we bring tracd into Apache's location namespace.
    293282
    294 {{{
     283{{{#!apache
    295284<Location /project/proxified>
    296285        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com
    … …  
    303292
    304293Then 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:
    305 {{{
    306 #!python
     294{{{#!python
    307295from trac.core import *
    308296from trac.config import BoolOption
    … …  
    313301    implements(IAuthenticator)
    314302
    315     obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false', 
    316                """Whether the 'Remote-User:' HTTP header is to be trusted for user logins 
    317                 (''since ??.??').""") 
     303    obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false',
     304               """Whether the 'Remote-User:' HTTP header is to be trusted for user logins
     305                (''since ??.??').""")
    318306
    319307    def authenticate(self, req):
    320         if self.obey_remote_user_header and req.get_header('Remote-User'): 
    321             return req.get_header('Remote-User') 
     308        if self.obey_remote_user_header and req.get_header('Remote-User'):
     309            return req.get_header('Remote-User')
    322310        return None
    323311
    … …  
    325313
    326314Add this new parameter to your TracIni:
    327 {{{
    328 ...
     315{{{#!ini
    329316[trac]
    330317...
    … …  
    334321
    335322Run tracd:
    336 {{{
    337 tracd -p 8101 -r -s proxified --base-path=/project/proxified
     323{{{#!sh
     324tracd -p 8101 -s proxified --base-path=/project/proxified
    338325}}}
    339326
    … …  
    341328
    342329Global config (e.g. `/srv/trac/conf/trac.ini`):
    343 {{{
     330{{{#!ini
    344331[components]
    345332remote-user-auth.* = enabled
    … …  
    351338
    352339Environment config (e.g. `/srv/trac/envs/myenv`):
    353 {{{
     340{{{#!ini
    354341[inherit]
    355342file = /srv/trac/conf/trac.ini
    356343}}}
    357344
    358 === Serving a different base path than / ===
     345=== Serving a different base path than /
    359346Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
    360 {{{
     347{{{#!sh
    361348 $ tracd --base-path=/some/path
    362349}}}