Changes between Version 2 and Version 3 of Trac Standalone


Ignore:
Timestamp:
Jun 21, 2015, 12:16:11 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Trac Standalone

    v2 v3  
    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.
     16   or [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
    1717
    1818== Usage examples ==
     
    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.
     24Strictly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
    2525{{{
    2626 $ tracd --hostname=localhost -p 8080 /path/to/project
     
    6060The spacing here is important.
    6161
     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
    6275For 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:
    6376{{{
     
    7184Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    7285
     86=== Option 3 ===
     87
     88also cygwin's cygrunsrv.exe can be used:
     89{{{
     90$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
     91$ net start tracd
     92}}}
     93
    7394== Using Authentication ==
    7495
    75 Using tracd with Apache .htpasswd files:
    76 
    77 To create a .htpasswd file using htpasswd:
    78 
    79 {{{
    80  $ htpasswd -c /path/to/env/.htpasswd username
    81 }}}
    82 then for additional users:
    83 {{{
    84  $ htpasswd /path/to/env/.htpasswd username2
    85 }}}
    86 then for starting the tracd (on windows skip the "=" after --basic-auth):
    87 {{{
    88 tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
    89 }}}
    90 
    91  `environmentname` is the directory name of the Trac project folder, as opposed to `/fullpath/environmentname` which is the full path to the Trac project folder. See below for another example.
    92 
    93 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.)
    94 
    95   ''Support for Basic authentication was added in version 0.9.''
    96 
    97 The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth):
    98 
     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)
     97
     98Make 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.
     99
     100Tracd 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.
     101
     102The general format for using authentication is:
    99103{{{
    100104 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    101105}}}
    102 
    103106where:
    104 
    105107 * '''base_project_dir''': the base directory of the project specified as follows:
    106108   * when serving multiple projects: ''relative'' to the `project_path`
     
    111113 * '''project_path''': path of the project
    112114
     115 * **`--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.
     116
    113117Examples:
    114118
     
    133137}}}
    134138
    135 === Using a htpasswd password file ===
     139=== Basic Authorization: Using a htpasswd password file ===
    136140This section describes how to use `tracd` with Apache .htpasswd files.
    137141
     142  Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to
     143  decode some htpasswd formats.  Trac source code attempt an `import crypt` first, but there
     144  is no such package for Python 2.6. Only `SHA-1` passwords (since Trac 1.0) work without this module.
     145
    138146To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    139 
    140147{{{
    141148 $ sudo htpasswd -c /path/to/env/.htpasswd username
     
    147154
    148155Then to start `tracd` run something like this:
    149 
    150156{{{
    151157 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     
    153159
    154160For example:
    155 
    156161{{{
    157162 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
    158163}}}
    159 
    160164''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    161165
    162 === Using a htdigest password file ===
     166=== Digest authentication: Using a htdigest password file ===
    163167
    164168If 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.
    165169
    166 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
     170Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
    167171
    168172=== Generating Passwords Without Apache ===
    169173
    170 If you don't have Apache available, you can use this simple Python script to generate your passwords:
     174Basic 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.
     175
     176You can use this simple Python script to generate a '''digest''' password file:
    171177
    172178{{{
     
    202208}}}
    203209
    204 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):
     210Note: 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):
    205211
    206212{{{
     
    209215}}}
    210216
    211 
    212 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). 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.)
    213 
    214 It is possible to use md5sum utility to generate digest-password file using such method:
    215 {{{
    216  $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
    217 }}}
    218 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
     217==== Using `md5sum`
     218It is possible to use `md5sum` utility to generate digest-password file:
     219{{{
     220user=
     221realm=
     222password=
     223path_to_file=
     224echo ${user}:${realm}:$(printf "${user}:${realm}:${password}" | md5sum - | sed -e 's/\s\+-//') > ${path_to_file}
     225}}}
     226
     227== Reference ==
     228
     229Here's the online help, as a reminder (`tracd --help`):
     230{{{
     231Usage: tracd [options] [projenv] ...
     232
     233Options:
     234  --version             show program's version number and exit
     235  -h, --help            show this help message and exit
     236  -a DIGESTAUTH, --auth=DIGESTAUTH
     237                        [projectdir],[htdigest_file],[realm]
     238  --basic-auth=BASICAUTH
     239                        [projectdir],[htpasswd_file],[realm]
     240  -p PORT, --port=PORT  the port number to bind to
     241  -b HOSTNAME, --hostname=HOSTNAME
     242                        the host name or IP address to bind to
     243  --protocol=PROTOCOL   http|scgi|ajp|fcgi
     244  -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
     245  --http10              use HTTP/1.0 protocol version instead of HTTP/1.1
     246  --http11              use HTTP/1.1 protocol version (default)
     247  -e PARENTDIR, --env-parent-dir=PARENTDIR
     248                        parent directory of the project environments
     249  --base-path=BASE_PATH
     250                        the initial portion of the request URL's "path"
     251  -r, --auto-reload     restart automatically when sources are modified
     252  -s, --single-env      only serve a single project without the project list
     253  -d, --daemonize       run in the background as a daemon
     254  --pidfile=PIDFILE     when daemonizing, file to which to write pid
     255  --umask=MASK          when daemonizing, file mode creation mask to use, in
     256                        octal notation (default 022)
     257  --group=GROUP         the group to run as
     258  --user=USER           the user to run as
     259}}}
     260
     261Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
    219262
    220263== Tips ==
     
    235278 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
    236279
    237 === Using apache rewrite rules ===
    238 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.
     280=== Using tracd behind a proxy
     281
     282In some situations when you choose to use tracd behind Apache or another web server.
     283
     284In 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.
     285
     286If 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.
     287
     288See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
     289
     290=== Authentication for tracd behind a proxy
     291It is convenient to provide central external authentication to your tracd instances, instead of using {{{--basic-auth}}}. There is some discussion about this in #9206.
     292
     293Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
     294
     295First we bring tracd into Apache's location namespace.
     296
     297{{{
     298<Location /project/proxified>
     299        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com
     300        Require ldap-user somespecificusertoo
     301        ProxyPass http://localhost:8101/project/proxified/
     302        # Turns out we don't really need complicated RewriteRules here at all
     303        RequestHeader set REMOTE_USER %{REMOTE_USER}s
     304</Location>
     305}}}
     306
     307Then 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:
     308{{{
     309#!python
     310from trac.core import *
     311from trac.config import BoolOption
     312from trac.web.api import IAuthenticator
     313
     314class MyRemoteUserAuthenticator(Component):
     315
     316    implements(IAuthenticator)
     317
     318    obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false',
     319               """Whether the 'Remote-User:' HTTP header is to be trusted for user logins
     320                (''since ??.??').""")
     321
     322    def authenticate(self, req):
     323        if self.obey_remote_user_header and req.get_header('Remote-User'):
     324            return req.get_header('Remote-User')
     325        return None
     326
     327}}}
     328
     329Add this new parameter to your TracIni:
     330{{{
     331...
     332[trac]
     333...
     334obey_remote_user_header = true
     335...
     336}}}
     337
     338Run tracd:
     339{{{
     340tracd -p 8101 -r -s proxified --base-path=/project/proxified
     341}}}
     342
     343Note 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.
     344
     345Global config (e.g. `/srv/trac/conf/trac.ini`):
     346{{{
     347[components]
     348remote-user-auth.* = enabled
     349[inherit]
     350plugins_dir = /srv/trac/plugins
     351[trac]
     352obey_remote_user_header = true
     353}}}
     354
     355Environment config (e.g. `/srv/trac/envs/myenv`):
     356{{{
     357[inherit]
     358file = /srv/trac/conf/trac.ini
     359}}}
    239360
    240361=== Serving a different base path than / ===
     
    245366
    246367----
    247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]
     368See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]