Changes between Version 4 and Version 5 of TracStandalone


Ignore:
Timestamp:
2012-03-02T13:14:24Z (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v4 v5  
    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 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.
     97
     98The general format for using authentication is:
    9999{{{
    100100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    101101}}}
    102 
    103102where:
    104 
    105103 * '''base_project_dir''': the base directory of the project specified as follows:
    106104   * when serving multiple projects: ''relative'' to the `project_path`
     
    111109 * '''project_path''': path of the project
    112110
     111 * **`--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.
     112
    113113Examples:
    114114
     
    133133}}}
    134134
    135 === Using a htpasswd password file ===
     135=== Basic Authorization: Using a htpasswd password file ===
    136136This section describes how to use `tracd` with Apache .htpasswd files.
    137137
     138  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.
     141
    138142To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    139 
    140143{{{
    141144 $ sudo htpasswd -c /path/to/env/.htpasswd username
     
    147150
    148151Then to start `tracd` run something like this:
    149 
    150152{{{
    151153 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     
    153155
    154156For example:
    155 
    156157{{{
    157158 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
    158159}}}
    159 
    160160''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    161161
    162 === Using a htdigest password file ===
     162=== Digest authentication: Using a htdigest password file ===
    163163
    164164If 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.
     
    168168=== Generating Passwords Without Apache ===
    169169
    170 If you don't have Apache available, you can use this simple Python script to generate your passwords:
     170Basic Authorization can be accomplished via this [http://www.4webhelp.net/us/password.php online HTTP Password generator].  Copy the generated password-hash line to the .htpasswd file on your system.
     171
     172You can use this simple Python script to generate a '''digest''' password file:
    171173
    172174{{{
     
    202204}}}
    203205
    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):
     206Note: 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):
    205207
    206208{{{
     
    209211}}}
    210212
    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:
     213==== Using `md5sum`
     214It is possible to use `md5sum` utility to generate digest-password file:
    215215{{{
    216216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
    217217}}}
    218218and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
     219
     220== Reference ==
     221
     222Here's the online help, as a reminder (`tracd --help`):
     223{{{
     224Usage: tracd [options] [projenv] ...
     225
     226Options:
     227  --version             show program's version number and exit
     228  -h, --help            show this help message and exit
     229  -a DIGESTAUTH, --auth=DIGESTAUTH
     230                        [projectdir],[htdigest_file],[realm]
     231  --basic-auth=BASICAUTH
     232                        [projectdir],[htpasswd_file],[realm]
     233  -p PORT, --port=PORT  the port number to bind to
     234  -b HOSTNAME, --hostname=HOSTNAME
     235                        the host name or IP address to bind to
     236  --protocol=PROTOCOL   http|scgi|ajp
     237  -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
     238  --http10              use HTTP/1.0 protocol version (default)
     239  --http11              use HTTP/1.1 protocol version instead of HTTP/1.0
     240  -e PARENTDIR, --env-parent-dir=PARENTDIR
     241                        parent directory of the project environments
     242  --base-path=BASE_PATH
     243                        the initial portion of the request URL's "path"
     244  -r, --auto-reload     restart automatically when sources are modified
     245  -s, --single-env      only serve a single project without the project list
     246}}}
    219247
    220248== Tips ==
     
    235263 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
    236264
    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.
     265=== Using tracd behind a proxy
     266
     267In some situations when you choose to use tracd behind Apache or another web server.
     268
     269In 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.
     270
     271If 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.
     272
     273See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
     274
     275=== Authentication for tracd behind a proxy
     276It is convenient to provide central external authentication to your tracd instances, instead of using {{{--basic-auth}}}. There is some discussion about this in #9206.
     277
     278Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
     279
     280First we bring tracd into Apache's location namespace.
     281
     282{{{
     283<Location /project/proxified>
     284        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com
     285        Require ldap-user somespecificusertoo
     286        ProxyPass http://localhost:8101/project/proxified/
     287        # Turns out we don't really need complicated RewriteRules here at all
     288        RequestHeader set REMOTE_USER %{REMOTE_USER}s
     289</Location>
     290}}}
     291
     292Then 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:
     293{{{
     294#!python
     295from trac.core import *
     296from trac.config import BoolOption
     297from trac.web.api import IAuthenticator
     298
     299class MyRemoteUserAuthenticator(Component):
     300
     301    implements(IAuthenticator)
     302
     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 ??.??').""")
     306
     307    def authenticate(self, req):
     308        if self.obey_remote_user_header and req.get_header('Remote-User'):
     309            return req.get_header('Remote-User')
     310        return None
     311
     312}}}
     313
     314Add this new parameter to your TracIni:
     315{{{
     316...
     317[trac]
     318...
     319obey_remote_user_header = true
     320...
     321}}}
     322
     323Run tracd:
     324{{{
     325tracd -p 8101 -r -s proxified --base-path=/project/proxified
     326}}}
    239327
    240328=== Serving a different base path than / ===
     
    245333
    246334----
    247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]
     335See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]