| | 43 | == Installing as a Windows Service == |
| | 44 | |
| | 45 | === Option 1 === |
| | 46 | To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run: |
| | 47 | {{{ |
| | 48 | C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe |
| | 49 | 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>" |
| | 50 | net start tracd |
| | 51 | }}} |
| | 52 | |
| | 53 | '''DO NOT''' use {{{tracd.exe}}}. Instead register {{{python.exe}}} directly with {{{tracd-script.py}}} as a parameter. If you use {{{tracd.exe}}}, it will spawn the python process without SRVANY's knowledge. This python process will survive a {{{net stop tracd}}}. |
| | 54 | |
| | 55 | If you want tracd to start automatically when you boot Windows, do: |
| | 56 | {{{ |
| | 57 | sc config tracd start= auto |
| | 58 | }}} |
| | 59 | |
| | 60 | The spacing here is important. |
| | 61 | |
| | 62 | {{{#!div |
| | 63 | Once 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 | |
| | 66 | Three (string) parameters are provided: |
| | 67 | ||!AppDirectory ||C:\Python26\ || |
| | 68 | ||Application ||python.exe || |
| | 69 | ||!AppParameters ||scripts\tracd-script.py -p 8080 ... || |
| | 70 | |
| | 71 | Note 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 | |
| | 75 | For 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 | {{{ |
| | 77 | "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 | |
| | 79 | net start tracd |
| | 80 | }}} |
| | 81 | |
| | 82 | === Option 2 === |
| | 83 | |
| | 84 | Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. |
| | 85 | |
| | 86 | === Option 3 === |
| | 87 | |
| | 88 | also 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 | }}} |
| 45 | | Using tracd with Apache .htpasswd files: |
| 46 | | |
| 47 | | To create a .htpasswd file using htpasswd: |
| 48 | | |
| 49 | | {{{ |
| 50 | | sudo htpasswd -c /path/to/env/.htpasswd username |
| | 96 | 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) |
| | 97 | |
| | 98 | 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) may go undetected. |
| | 99 | |
| | 100 | Tracd 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 | |
| | 102 | The general format for using authentication is: |
| | 103 | {{{ |
| | 104 | $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path |
| | 105 | }}} |
| | 106 | where: |
| | 107 | * '''base_project_dir''': the base directory of the project specified as follows: |
| | 108 | * when serving multiple projects: ''relative'' to the `project_path` |
| | 109 | * when serving only a single project (`-s`): the name of the project directory |
| | 110 | Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. |
| | 111 | * '''password_file_path''': path to the password file |
| | 112 | * '''realm''': the realm name (can be anything) |
| | 113 | * '''project_path''': path of the project |
| | 114 | |
| | 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 | |
| | 117 | Examples: |
| | 118 | |
| | 119 | {{{ |
| | 120 | $ tracd -p 8080 \ |
| | 121 | --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 |
| | 122 | }}} |
| | 123 | |
| | 124 | Of course, the password file can be be shared so that it is used for more than one project: |
| | 125 | {{{ |
| | 126 | $ tracd -p 8080 \ |
| | 127 | --auth="project1,/path/to/passwordfile,mycompany.com" \ |
| | 128 | --auth="project2,/path/to/passwordfile,mycompany.com" \ |
| | 129 | /path/to/project1 /path/to/project2 |
| | 130 | }}} |
| | 131 | |
| | 132 | Another way to share the password file is to specify "*" for the project name: |
| | 133 | {{{ |
| | 134 | $ tracd -p 8080 \ |
| | 135 | --auth="*,/path/to/users.htdigest,mycompany.com" \ |
| | 136 | /path/to/project1 /path/to/project2 |
| | 137 | }}} |
| | 138 | |
| | 139 | === Basic Authorization: Using a htpasswd password file === |
| | 140 | This section describes how to use `tracd` with Apache .htpasswd files. |
| | 141 | |
| | 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 | |
| | 146 | To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): |
| | 147 | {{{ |
| | 148 | $ sudo htpasswd -c /path/to/env/.htpasswd username |
| 54 | | sudo htpasswd /var/www/html/.htpasswd-users username2 |
| 55 | | }}} |
| 56 | | then for starting the tracd: |
| 57 | | {{{ |
| 58 | | tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname |
| 59 | | }}} |
| 60 | | |
| 61 | | |
| 62 | | 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.) |
| 63 | | |
| 64 | | ''Support for Basic authentication was added in version 0.9.'' |
| 65 | | |
| 66 | | The general format for using authentication is: |
| 67 | | |
| 68 | | {{{ |
| 69 | | $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path |
| 70 | | }}} |
| 71 | | |
| 72 | | where: |
| 73 | | |
| 74 | | * '''base_project_dir''' is the base directory of the project; note: this doesn't refer to the project name, and it is case-sensitive even for windows environments |
| 75 | | * '''password_file_path''' path of the password file |
| 76 | | * '''realm''' realm |
| 77 | | * '''project_path''' path of the project |
| 78 | | |
| 79 | | Example: |
| 80 | | |
| 81 | | {{{ |
| 82 | | $ tracd -p 8080 \ |
| 83 | | --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 |
| 84 | | }}} |
| 85 | | Of course, the digest file can be be shared so that it is used for more than one project: |
| 86 | | {{{ |
| 87 | | $ tracd -p 8080 \ |
| 88 | | --auth=project1,/path/to/users.htdigest,mycompany.com \ |
| 89 | | --auth=project2,/path/to/users.htdigest,mycompany.com \ |
| 90 | | /path/to/project1 /path/to/project2 |
| 91 | | }}} |
| 92 | | |
| 93 | | Another way to share the digest file is to specify "*" |
| 94 | | for the project name: |
| 95 | | {{{ |
| 96 | | $ tracd -p 8080 \ |
| 97 | | --auth=*,/path/to/users.htdigest,mycompany.com \ |
| 98 | | /path/to/project1 /path/to/project2 |
| 99 | | }}} |
| 100 | | |
| 101 | | == How to set up an htdigest password file == |
| | 152 | $ sudo htpasswd /path/to/env/.htpasswd username2 |
| | 153 | }}} |
| | 154 | |
| | 155 | Then to start `tracd` run something like this: |
| | 156 | {{{ |
| | 157 | $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname |
| | 158 | }}} |
| | 159 | |
| | 160 | For example: |
| | 161 | {{{ |
| | 162 | $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv |
| | 163 | }}} |
| | 164 | ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). |
| | 165 | |
| | 166 | === Digest authentication: Using a htdigest password file === |
| 135 | | 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): |
| 136 | | |
| 137 | | {{{ |
| 138 | | python trac-digest.py -u username -p password >> c:\digest.txt |
| 139 | | tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name |
| 140 | | }}} |
| 141 | | |
| 142 | | 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). When using on Windows make sure to use -m option for it (did not tested it on *nix, so not sure if that is the case there). If you do not have Apache, [trac:source:/tags/trac-0.11b2/contrib/htpasswd.py htpasswd.py] may help. (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.) |
| 143 | | |
| 144 | | It is possible to use md5sum utility to generate digest-password file using such method: |
| 145 | | {{{ |
| 146 | | echo -e "${user}:trac:${password}\c" | md5sum - >>to-file |
| 147 | | }}} |
| 148 | | and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. You can see attachment:trac-digest-corrected.sh for detail. |
| | 210 | Note: 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): |
| | 211 | |
| | 212 | {{{ |
| | 213 | $ python trac-digest.py -u username -p password >> c:\digest.txt |
| | 214 | $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name |
| | 215 | }}} |
| | 216 | |
| | 217 | ==== Using `md5sum` |
| | 218 | It is possible to use `md5sum` utility to generate digest-password file: |
| | 219 | {{{ |
| | 220 | user= |
| | 221 | realm= |
| | 222 | password= |
| | 223 | path_to_file= |
| | 224 | echo ${user}:${realm}:$(printf "${user}:${realm}:${password}" | md5sum - | sed -e 's/\s\+-//') > ${path_to_file} |
| | 225 | }}} |
| | 226 | |
| | 227 | == Reference == |
| | 228 | |
| | 229 | Here's the online help, as a reminder (`tracd --help`): |
| | 230 | {{{ |
| | 231 | Usage: tracd [options] [projenv] ... |
| | 232 | |
| | 233 | Options: |
| | 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 | |
| | 261 | Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. |
| 163 | | which in turn can be written using the relative link syntax |
| 164 | | in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` |
| 165 | | |
| 166 | | The development version of Trac supports a new `htdocs:` TracLinks |
| 167 | | syntax for the above. With this, the example link above can be written simply |
| 168 | | `htdocs:software-0.1.tar.gz`. |
| 169 | | |
| 170 | | === Using apache rewrite rules === |
| 171 | | 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. |
| | 276 | 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). |
| | 277 | |
| | 278 | ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' |
| | 279 | |
| | 280 | === Using tracd behind a proxy |
| | 281 | |
| | 282 | In some situations when you choose to use tracd behind Apache or another web server. |
| | 283 | |
| | 284 | In 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 | |
| | 286 | If 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 | |
| | 288 | See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]. |
| | 289 | |
| | 290 | === Authentication for tracd behind a proxy |
| | 291 | It 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 | |
| | 293 | Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. |
| | 294 | |
| | 295 | First 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 | |
| | 307 | Then 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 |
| | 310 | from trac.core import * |
| | 311 | from trac.config import BoolOption |
| | 312 | from trac.web.api import IAuthenticator |
| | 313 | |
| | 314 | class 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 | |
| | 329 | Add this new parameter to your TracIni: |
| | 330 | {{{ |
| | 331 | ... |
| | 332 | [trac] |
| | 333 | ... |
| | 334 | obey_remote_user_header = true |
| | 335 | ... |
| | 336 | }}} |
| | 337 | |
| | 338 | Run tracd: |
| | 339 | {{{ |
| | 340 | tracd -p 8101 -r -s proxified --base-path=/project/proxified |
| | 341 | }}} |
| | 342 | |
| | 343 | Note 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 | |
| | 345 | Global config (e.g. `/srv/trac/conf/trac.ini`): |
| | 346 | {{{ |
| | 347 | [components] |
| | 348 | remote-user-auth.* = enabled |
| | 349 | [inherit] |
| | 350 | plugins_dir = /srv/trac/plugins |
| | 351 | [trac] |
| | 352 | obey_remote_user_header = true |
| | 353 | }}} |
| | 354 | |
| | 355 | Environment config (e.g. `/srv/trac/envs/myenv`): |
| | 356 | {{{ |
| | 357 | [inherit] |
| | 358 | file = /srv/trac/conf/trac.ini |
| | 359 | }}} |
