Changes between Version 2 and Version 3 of TracStandalone


Ignore:
Timestamp:
Jul 12, 2012, 1:30:32 AM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v2 v3  
    8484Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    8585
     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
    8694== Using Authentication ==
    8795
    88 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.)
    89 
     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.
    9097
    9198The general format for using authentication is:
     
    93100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    94101}}}
    95 
    96102where:
    97 
    98103 * '''base_project_dir''': the base directory of the project specified as follows:
    99104   * when serving multiple projects: ''relative'' to the `project_path`
     
    103108 * '''realm''': the realm name (can be anything)
    104109 * '''project_path''': path of the project
    105  * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth
     110
     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.
    106112
    107113Examples:
     
    127133}}}
    128134
    129 === Using a htpasswd password file ===
     135=== Basic Authorization: Using a htpasswd password file ===
    130136This section describes how to use `tracd` with Apache .htpasswd files.
    131137
     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
    132142To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    133 
    134143{{{
    135144 $ sudo htpasswd -c /path/to/env/.htpasswd username
     
    141150
    142151Then to start `tracd` run something like this:
    143 
    144152{{{
    145153 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     
    147155
    148156For example:
    149 
    150157{{{
    151158 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
    152159}}}
    153 
    154160''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    155161
    156 === Using a htdigest password file ===
     162=== Digest authentication: Using a htdigest password file ===
    157163
    158164If 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.
     
    162168=== Generating Passwords Without Apache ===
    163169
    164 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:
    165173
    166174{{{
     
    196204}}}
    197205
    198 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):
    199207
    200208{{{
     
    203211}}}
    204212
    205 
    206 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.)
    207 
    208 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:
    209215{{{
    210216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
     
    267273See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
    268274
     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}}}
     327
    269328=== Serving a different base path than / ===
    270329Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is