Changes between Version 5 and Version 6 of TracStandalone


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (3 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 [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
    17 
    18 == Usage examples
     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 ==
    1919
    2020A single project on port 8080. (http://localhost:8080/)
    21 {{{#!sh
     21{{{
    2222 $ tracd -p 8080 /path/to/project
    2323}}}
    24 Strictly 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
     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{{{
    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 {{{#!sh
     29{{{
    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 {{{#!sh
     37{{{
    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 {{{#!cmd
     47{{{
    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 {{{#!cmd
     56{{{
    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 {{{#!cmd
     76{{{
    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
    7879net start tracd
    7980}}}
    8081
    81 === Option 2
     82=== Option 2 ===
    8283
    8384Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    8485
    85 === Option 3
     86=== Option 3 ===
    8687
    8788also cygwin's cygrunsrv.exe can be used:
    88 {{{#!sh
     89{{{
    8990$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
    9091$ net start tracd
    9192}}}
    9293
    93 == Using Authentication
    94 
    95 Tracd 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 
    97 {{{#!div style="border: 1pt dotted; margin: 1em"
    98 **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).
    99 }}}
     94== Using Authentication ==
     95
     96Tracd 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)
    10097
    10198Tracd 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.
    10299
    103100The general format for using authentication is:
    104 {{{#!sh
     101{{{
    105102 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    106103}}}
     
    118115Examples:
    119116
    120 {{{#!sh
     117{{{
    121118 $ tracd -p 8080 \
    122119   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
     
    124121
    125122Of course, the password file can be be shared so that it is used for more than one project:
    126 {{{#!sh
     123{{{
    127124 $ tracd -p 8080 \
    128125   --auth="project1,/path/to/passwordfile,mycompany.com" \
     
    132129
    133130Another way to share the password file is to specify "*" for the project name:
    134 {{{#!sh
     131{{{
    135132 $ tracd -p 8080 \
    136133   --auth="*,/path/to/users.htdigest,mycompany.com" \
     
    138135}}}
    139136
    140 === Basic Authorization: Using a htpasswd password file
     137=== Basic Authorization: Using a htpasswd password file ===
    141138This section describes how to use `tracd` with Apache .htpasswd files.
    142139
     
    146143
    147144To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    148 {{{#!sh
     145{{{
    149146 $ sudo htpasswd -c /path/to/env/.htpasswd username
    150147}}}
    151148then for additional users:
    152 {{{#!sh
     149{{{
    153150 $ sudo htpasswd /path/to/env/.htpasswd username2
    154151}}}
    155152
    156153Then to start `tracd` run something like this:
    157 {{{#!sh
    158  $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project
     154{{{
     155 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
    159156}}}
    160157
    161158For example:
    162 {{{#!sh
    163  $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
     159{{{
     160 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
    164161}}}
    165162''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    166163
    167 === Digest authentication: Using a htdigest password file
     164=== Digest authentication: Using a htdigest password file ===
    168165
    169166If 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.
     
    171168Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
    172169
    173 === Generating Passwords Without Apache
    174 
    175 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.
    176 
    177 Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
    178 {{{#!sh
    179 $ ./contrib/htpasswd.py -cb htpasswd user1 user1
    180 $ ./contrib/htpasswd.py -b htpasswd user2 user2
    181 }}}
    182 
    183 {{{#!sh
    184 $ ./contrib/htdigest.py -cb htdigest trac user1 user1
    185 $ ./contrib/htdigest.py -b htdigest trac user2 user2
     170=== Generating Passwords Without Apache ===
     171
     172Basic 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.
     173
     174You can use this simple Python script to generate a '''digest''' password file:
     175
     176{{{
     177#!python
     178from optparse import OptionParser
     179# The md5 module is deprecated in Python 2.5
     180try:
     181    from hashlib import md5
     182except ImportError:
     183    from md5 import md5
     184realm = 'trac'
     185
     186# build the options
     187usage = "usage: %prog [options]"
     188parser = OptionParser(usage=usage)
     189parser.add_option("-u", "--username",action="store", dest="username", type = "string",
     190                  help="the username for whom to generate a password")
     191parser.add_option("-p", "--password",action="store", dest="password", type = "string",
     192                  help="the password to use")
     193parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     194                  help="the realm in which to create the digest")
     195(options, args) = parser.parse_args()
     196
     197# check options
     198if (options.username is None) or (options.password is None):
     199   parser.error("You must supply both the username and password")
     200if (options.realm is not None):
     201   realm = options.realm
     202   
     203# Generate the string to enter into the htdigest file
     204kd = lambda x: md5(':'.join(x)).hexdigest()
     205print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
     206}}}
     207
     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{{{
     211 $ python trac-digest.py -u username -p password >> c:\digest.txt
     212 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
    186213}}}
    187214
    188215==== Using `md5sum`
    189216It is possible to use `md5sum` utility to generate digest-password file:
    190 {{{#!sh
     217{{{
    191218user=
    192219realm=
     
    196223}}}
    197224
    198 == Reference
     225== Reference ==
    199226
    200227Here's the online help, as a reminder (`tracd --help`):
     
    232259Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
    233260
    234 == Tips
    235 
    236 === Serving static content
     261== Tips ==
     262
     263=== Serving static content ===
    237264
    238265If `tracd` is the only web server used for the project,
     
    245272Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    246273the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    247 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).
     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 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
    248277
    249278=== Using tracd behind a proxy
     
    258287
    259288=== Authentication for tracd behind a proxy
    260 It 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].
     289It is convenient to provide central external authentication to your tracd instances, instead of using {{{--basic-auth}}}. There is some discussion about this in #9206.
    261290
    262291Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
     
    264293First we bring tracd into Apache's location namespace.
    265294
    266 {{{#!apache
     295{{{
    267296<Location /project/proxified>
    268297        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com
     
    275304
    276305Then 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:
    277 {{{#!python
     306{{{
     307#!python
    278308from trac.core import *
    279309from trac.config import BoolOption
     
    296326
    297327Add this new parameter to your TracIni:
    298 {{{#!ini
     328{{{
     329...
    299330[trac]
    300331...
     
    304335
    305336Run tracd:
    306 {{{#!sh
    307 tracd -p 8101 -s proxified --base-path=/project/proxified
     337{{{
     338tracd -p 8101 -r -s proxified --base-path=/project/proxified
    308339}}}
    309340
     
    311342
    312343Global config (e.g. `/srv/trac/conf/trac.ini`):
    313 {{{#!ini
     344{{{
    314345[components]
    315346remote-user-auth.* = enabled
     
    321352
    322353Environment config (e.g. `/srv/trac/envs/myenv`):
    323 {{{#!ini
     354{{{
    324355[inherit]
    325356file = /srv/trac/conf/trac.ini
    326357}}}
    327358
    328 === Serving a different base path than /
     359=== Serving a different base path than / ===
    329360Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
    330 {{{#!sh
     361{{{
    331362 $ tracd --base-path=/some/path
    332363}}}