Changes between Version 5 and Version 6 of TracStandalone


Ignore:
Timestamp:
08/12/2013 11:07:42 PM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v5 v6  
     1** Note: this page documents the version 1.0 of Trac, see [[0.12/TracStandalone]] if you need the previous version ** 
    12= Tracd = 
    23 
     
    6061The spacing here is important. 
    6162 
     63{{{#!div 
     64Once 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]] 
     65`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters` 
     66 
     67Three (string) parameters are provided: 
     68||!AppDirectory ||C:\Python26\ || 
     69||Application ||python.exe || 
     70||!AppParameters ||scripts\tracd-script.py -p 8080 ... || 
     71 
     72Note 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. 
     73(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.) 
     74}}} 
     75 
    6276For 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: 
    6377{{{ 
     
    7185Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 
    7286 
     87=== Option 3 === 
     88 
     89also cygwin's cygrunsrv.exe can be used: 
     90{{{ 
     91$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects' 
     92$ net start tracd 
     93}}} 
     94 
    7395== Using Authentication == 
    7496 
    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  
     97Tracd 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. 
     98 
     99The general format for using authentication is: 
    99100{{{ 
    100101 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 
    101102}}} 
    102  
    103103where: 
    104  
    105104 * '''base_project_dir''': the base directory of the project specified as follows: 
    106105   * when serving multiple projects: ''relative'' to the `project_path` 
     
    111110 * '''project_path''': path of the project 
    112111 
     112 * **`--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. 
     113 
    113114Examples: 
    114115 
     
    133134}}} 
    134135 
    135 === Using a htpasswd password file === 
     136=== Basic Authorization: Using a htpasswd password file === 
    136137This section describes how to use `tracd` with Apache .htpasswd files. 
    137138 
     139  Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to 
     140  decode some htpasswd formats.  Trac source code attempt an `import crypt` first, but there 
     141  is no such package for Python 2.6. Only `SHA-1` passwords (since Trac 1.0) work without this module. 
     142 
    138143To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 
    139  
    140144{{{ 
    141145 $ sudo htpasswd -c /path/to/env/.htpasswd username 
     
    147151 
    148152Then to start `tracd` run something like this: 
    149  
    150153{{{ 
    151154 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 
     
    153156 
    154157For example: 
    155  
    156158{{{ 
    157159 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 
    158160}}} 
    159  
    160161''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 
    161162 
    162 === Using a htdigest password file === 
     163=== Digest authentication: Using a htdigest password file === 
    163164 
    164165If 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. 
    165166 
    166 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 
     167Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. 
    167168 
    168169=== Generating Passwords Without Apache === 
    169170 
    170 If you don't have Apache available, you can use this simple Python script to generate your passwords: 
     171Basic 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. 
     172 
     173You can use this simple Python script to generate a '''digest''' password file: 
    171174 
    172175{{{ 
     
    202205}}} 
    203206 
    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): 
     207Note: 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): 
    205208 
    206209{{{ 
     
    209212}}} 
    210213 
    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'. 
     214==== Using `md5sum` 
     215It is possible to use `md5sum` utility to generate digest-password file: 
     216{{{ 
     217user= 
     218realm= 
     219password= 
     220path_to_file= 
     221echo ${user}:${realm}:$(printf "${user}:${realm}:${password}" | md5sum - | sed -e 's/\s\+-//') > ${path_to_file} 
     222}}} 
     223 
     224== Reference == 
     225 
     226Here's the online help, as a reminder (`tracd --help`): 
     227{{{ 
     228Usage: tracd [options] [projenv] ... 
     229 
     230Options: 
     231  --version             show program's version number and exit 
     232  -h, --help            show this help message and exit 
     233  -a DIGESTAUTH, --auth=DIGESTAUTH 
     234                        [projectdir],[htdigest_file],[realm] 
     235  --basic-auth=BASICAUTH 
     236                        [projectdir],[htpasswd_file],[realm] 
     237  -p PORT, --port=PORT  the port number to bind to 
     238  -b HOSTNAME, --hostname=HOSTNAME 
     239                        the host name or IP address to bind to 
     240  --protocol=PROTOCOL   http|scgi|ajp|fcgi 
     241  -q, --unquote         unquote PATH_INFO (may be needed when using ajp) 
     242  --http10              use HTTP/1.0 protocol version instead of HTTP/1.1 
     243  --http11              use HTTP/1.1 protocol version (default) 
     244  -e PARENTDIR, --env-parent-dir=PARENTDIR 
     245                        parent directory of the project environments 
     246  --base-path=BASE_PATH 
     247                        the initial portion of the request URL's "path" 
     248  -r, --auto-reload     restart automatically when sources are modified 
     249  -s, --single-env      only serve a single project without the project list 
     250  -d, --daemonize       run in the background as a daemon 
     251  --pidfile=PIDFILE     when daemonizing, file to which to write pid 
     252  --umask=MASK          when daemonizing, file mode creation mask to use, in 
     253                        octal notation (default 022) 
     254  --group=GROUP         the group to run as 
     255  --user=USER           the user to run as 
     256}}} 
     257 
     258Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 
    219259 
    220260== Tips == 
     
    235275 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 
    236276 
    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. 
     277=== Using tracd behind a proxy 
     278 
     279In some situations when you choose to use tracd behind Apache or another web server. 
     280 
     281In 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. 
     282 
     283If 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. 
     284 
     285See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]. 
     286 
     287=== Authentication for tracd behind a proxy 
     288It is convenient to provide central external authentication to your tracd instances, instead of using {{{--basic-auth}}}. There is some discussion about this in #9206. 
     289 
     290Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. 
     291 
     292First we bring tracd into Apache's location namespace. 
     293 
     294{{{ 
     295<Location /project/proxified> 
     296        Require ldap-group cn=somegroup, ou=Groups,dc=domain.com 
     297        Require ldap-user somespecificusertoo 
     298        ProxyPass http://localhost:8101/project/proxified/ 
     299        # Turns out we don't really need complicated RewriteRules here at all 
     300        RequestHeader set REMOTE_USER %{REMOTE_USER}s 
     301</Location> 
     302}}} 
     303 
     304Then 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: 
     305{{{ 
     306#!python 
     307from trac.core import * 
     308from trac.config import BoolOption 
     309from trac.web.api import IAuthenticator 
     310 
     311class MyRemoteUserAuthenticator(Component): 
     312 
     313    implements(IAuthenticator) 
     314 
     315    obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false',  
     316               """Whether the 'Remote-User:' HTTP header is to be trusted for user logins  
     317                (''since ??.??').""")  
     318 
     319    def authenticate(self, req): 
     320        if self.obey_remote_user_header and req.get_header('Remote-User'):  
     321            return req.get_header('Remote-User')  
     322        return None 
     323 
     324}}} 
     325 
     326Add this new parameter to your TracIni: 
     327{{{ 
     328... 
     329[trac] 
     330... 
     331obey_remote_user_header = true 
     332... 
     333}}} 
     334 
     335Run tracd: 
     336{{{ 
     337tracd -p 8101 -r -s proxified --base-path=/project/proxified 
     338}}} 
     339 
     340Note 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. 
     341 
     342Global config (e.g. `/srv/trac/conf/trac.ini`): 
     343{{{ 
     344[components] 
     345remote-user-auth.* = enabled 
     346[inherit] 
     347plugins_dir = /srv/trac/plugins 
     348[trac] 
     349obey_remote_user_header = true 
     350}}} 
     351 
     352Environment config (e.g. `/srv/trac/envs/myenv`): 
     353{{{ 
     354[inherit] 
     355file = /srv/trac/conf/trac.ini 
     356}}} 
    239357 
    240358=== Serving a different base path than / === 
     
    245363 
    246364---- 
    247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe] 
     365See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]