Changes between Version 5 and Version 6 of TracStandalone


Ignore:
Timestamp:
Jul 23, 2015, 11:47:36 AM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v5 v6  
    1 = Tracd =
     1= Tracd
    22
    33Tracd is a lightweight standalone Trac web server.
    44It 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.
    55
    6 == Pros ==
     6== Pros
    77
    88 * Fewer dependencies: You don't need to install apache or any other web-server.
     
    1010 * 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).
    1111
    12 == Cons ==
     12== Cons
    1313
    1414 * 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 
    45 === Option 1 ===
     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
    4646To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    47 {{{
     47{{{#!cmd
    4848 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
    4949 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>"
     
    5454
    5555If you want tracd to start automatically when you boot Windows, do:
    56 {{{
     56{{{#!cmd
    5757 sc config tracd start= auto
    5858}}}
     
    7474
    7575For 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 {{{
     76{{{#!cmd
    7777"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 
    7978net start tracd
    8079}}}
    8180
    82 === Option 2 ===
     81=== Option 2
    8382
    8483Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    8584
    86 === Option 3 ===
     85=== Option 3
    8786
    8887also cygwin's cygrunsrv.exe can be used:
    89 {{{
     88{{{#!sh
    9089$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
    9190$ net start tracd
    9291}}}
    9392
    94 == Using Authentication ==
     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, or HFS+ on OSX).
    9598
    9699Tracd 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.
    97100
    98101The general format for using authentication is:
    99 {{{
     102{{{#!sh
    100103 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    101104}}}
     
    113116Examples:
    114117
    115 {{{
     118{{{#!sh
    116119 $ tracd -p 8080 \
    117120   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
     
    119122
    120123Of course, the password file can be be shared so that it is used for more than one project:
    121 {{{
     124{{{#!sh
    122125 $ tracd -p 8080 \
    123126   --auth="project1,/path/to/passwordfile,mycompany.com" \
     
    127130
    128131Another way to share the password file is to specify "*" for the project name:
    129 {{{
     132{{{#!sh
    130133 $ tracd -p 8080 \
    131134   --auth="*,/path/to/users.htdigest,mycompany.com" \
     
    133136}}}
    134137
    135 === Basic Authorization: Using a htpasswd password file ===
     138=== Basic Authorization: Using a htpasswd password file
    136139This section describes how to use `tracd` with Apache .htpasswd files.
    137140
    138141  Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to
    139   decode the htpasswd format.  Trac source code attempt an `import crypt` first, but there
    140   is no such package for Python 2.6.
     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.
    141144
    142145To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    143 {{{
     146{{{#!sh
    144147 $ sudo htpasswd -c /path/to/env/.htpasswd username
    145148}}}
    146149then for additional users:
    147 {{{
     150{{{#!sh
    148151 $ sudo htpasswd /path/to/env/.htpasswd username2
    149152}}}
    150153
    151154Then to start `tracd` run something like this:
    152 {{{
    153  $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     155{{{#!sh
     156 $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project
    154157}}}
    155158
    156159For example:
    157 {{{
    158  $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     160{{{#!sh
     161 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
    159162}}}
    160163''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    161164
    162 === Digest authentication: Using a htdigest password file ===
     165=== Digest authentication: Using a htdigest password file
    163166
    164167If 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.
    165168
    166 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
    167 
    168 === Generating Passwords Without Apache ===
    169 
    170 Basic Authorization can be accomplished via this [http://aspirine.org/htpasswd_en.html online HTTP Password generator].  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.
    171 
    172 You can use this simple Python script to generate a '''digest''' password file:
    173 
    174 {{{
    175 #!python
    176 from optparse import OptionParser
    177 # The md5 module is deprecated in Python 2.5
    178 try:
    179     from hashlib import md5
    180 except ImportError:
    181     from md5 import md5
    182 realm = 'trac'
    183 
    184 # build the options
    185 usage = "usage: %prog [options]"
    186 parser = OptionParser(usage=usage)
    187 parser.add_option("-u", "--username",action="store", dest="username", type = "string",
    188                   help="the username for whom to generate a password")
    189 parser.add_option("-p", "--password",action="store", dest="password", type = "string",
    190                   help="the password to use")
    191 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
    192                   help="the realm in which to create the digest")
    193 (options, args) = parser.parse_args()
    194 
    195 # check options
    196 if (options.username is None) or (options.password is None):
    197    parser.error("You must supply both the username and password")
    198 if (options.realm is not None):
    199    realm = options.realm
    200    
    201 # Generate the string to enter into the htdigest file
    202 kd = lambda x: md5(':'.join(x)).hexdigest()
    203 print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
    204 }}}
    205 
    206 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):
    207 
    208 {{{
    209  $ python trac-digest.py -u username -p password >> c:\digest.txt
    210  $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     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
     175Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
     176{{{#!sh
     177$ ./contrib/htpasswd.py -cb htpasswd user1 user1
     178$ ./contrib/htpasswd.py -b htpasswd user2 user2
     179}}}
     180
     181{{{#!sh
     182$ ./contrib/htdigest.py -cb htdigest trac user1 user1
     183$ ./contrib/htdigest.py -b htdigest trac user2 user2
    211184}}}
    212185
    213186==== Using `md5sum`
    214187It is possible to use `md5sum` utility to generate digest-password file:
    215 {{{
     188{{{#!sh
    216189user=
    217190realm=
     
    221194}}}
    222195
    223 == Reference ==
     196== Reference
    224197
    225198Here's the online help, as a reminder (`tracd --help`):
     
    248221  -s, --single-env      only serve a single project without the project list
    249222  -d, --daemonize       run in the background as a daemon
    250   --pidfile=PIDFILE     When daemonizing, file to which to write pid
    251   --umask=MASK          When daemonizing, file mode creation mask to use, in
     223  --pidfile=PIDFILE     when daemonizing, file to which to write pid
     224  --umask=MASK          when daemonizing, file mode creation mask to use, in
    252225                        octal notation (default 022)
     226  --group=GROUP         the group to run as
     227  --user=USER           the user to run as
    253228}}}
    254229
    255230Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
    256231
    257 == Tips ==
    258 
    259 === Serving static content ===
     232== Tips
     233
     234=== Serving static content
    260235
    261236If `tracd` is the only web server used for the project,
     
    268243Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    269244the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    270 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).
    271 
    272  ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
     245which 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).
    273246
    274247=== Using tracd behind a proxy
     
    283256
    284257=== Authentication for tracd behind a proxy
    285 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.
     258It 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].
    286259
    287260Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
     
    289262First we bring tracd into Apache's location namespace.
    290263
    291 {{{
     264{{{#!apache
    292265<Location /project/proxified>
    293266        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com
     
    300273
    301274Then 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:
    302 {{{
    303 #!python
     275{{{#!python
    304276from trac.core import *
    305277from trac.config import BoolOption
     
    322294
    323295Add this new parameter to your TracIni:
    324 {{{
    325 ...
     296{{{#!ini
    326297[trac]
    327298...
     
    331302
    332303Run tracd:
    333 {{{
     304{{{#!sh
    334305tracd -p 8101 -r -s proxified --base-path=/project/proxified
    335306}}}
    336307
    337 === Serving a different base path than / ===
     308Note 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.
     309
     310Global config (e.g. `/srv/trac/conf/trac.ini`):
     311{{{#!ini
     312[components]
     313remote-user-auth.* = enabled
     314[inherit]
     315plugins_dir = /srv/trac/plugins
     316[trac]
     317obey_remote_user_header = true
     318}}}
     319
     320Environment config (e.g. `/srv/trac/envs/myenv`):
     321{{{#!ini
     322[inherit]
     323file = /srv/trac/conf/trac.ini
     324}}}
     325
     326=== Serving a different base path than /
    338327Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
    339 {{{
     328{{{#!sh
    340329 $ tracd --base-path=/some/path
    341330}}}