Changes between Version 3 and Version 4 of TracStandalone
- Timestamp:
- Jan 21, 2013, 6:45:25 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v3 v4 1 1 = Tracd = 2 2 3 Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script]. 3 Tracd is a lightweight standalone Trac web server. 4 It can be used in a variety of situations, from a test or development server to a multiprocess setup behind another web server used as a load balancer. 4 5 5 6 == Pros == 6 7 7 8 * Fewer dependencies: You don't need to install apache or any other web-server. 8 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]) .9 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]), even more so since version 0.12 where the HTTP/1.1 version of the protocol is enabled by default 9 10 * Automatic reloading: For development, Tracd can be used in ''auto_reload'' mode, which will automatically restart the server whenever you make a change to the code (in Trac itself or in a plugin). 10 * Options for tracd: `-r, --auto-reload`11 11 12 12 == Cons == 13 13 14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD.14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd. 15 15 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 16 16 or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. … … 60 60 The spacing here is important. 61 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 62 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: 63 76 {{{ … … 71 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. 72 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 }}} 93 73 94 == Using Authentication == 74 `tracd` provides support for both Basic and Digest authentication. The default is to use Digest. 75 76 ''Support for Basic authentication was added in version 0.9.'' 77 78 The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth): 79 95 96 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. 97 98 The general format for using authentication is: 80 99 {{{ 81 100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 82 101 }}} 83 84 102 where: 85 86 103 * '''base_project_dir''': the base directory of the project specified as follows: 87 * when serving multiple projects: ''relative'' to the `project_ bath`104 * when serving multiple projects: ''relative'' to the `project_path` 88 105 * when serving only a single project (`-s`): the name of the project directory 89 106 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. … … 92 109 * '''project_path''': path of the project 93 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. 112 94 113 Examples: 95 114 … … 114 133 }}} 115 134 116 === Using a htpasswd password file ===135 === Basic Authorization: Using a htpasswd password file === 117 136 This section describes how to use `tracd` with Apache .htpasswd files. 118 137 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 119 142 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 120 121 143 {{{ 122 144 $ sudo htpasswd -c /path/to/env/.htpasswd username … … 128 150 129 151 Then to start `tracd` run something like this: 130 131 152 {{{ 132 153 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname … … 134 155 135 156 For example: 136 137 157 {{{ 138 158 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 139 159 }}} 140 141 160 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 142 161 143 === Using a htdigest password file ===162 === Digest authentication: Using a htdigest password file === 144 163 145 164 If 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. … … 149 168 === Generating Passwords Without Apache === 150 169 151 If you don't have Apache available, you can use this simple Python script to generate your passwords: 170 Basic Authorization can be accomplished via this [http://aspirine.org/htpasswd_en.html online HTTP Password generator]. 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. 171 172 You can use this simple Python script to generate a '''digest''' password file: 152 173 153 174 {{{ … … 183 204 }}} 184 205 185 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):206 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): 186 207 187 208 {{{ … … 190 211 }}} 191 212 192 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.) 193 194 It is possible to use md5sum utility to generate digest-password file using such method: 195 {{{ 196 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 197 }}} 198 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 213 ==== Using `md5sum` 214 It is possible to use `md5sum` utility to generate digest-password file: 215 {{{ 216 user= 217 realm= 218 password= 219 path_to_file= 220 echo ${user}:${realm}:$(printf "${user}:${realm}:${password}" | md5sum - | sed -e 's/\s\+-//') > ${path_to_file} 221 }}} 222 223 == Reference == 224 225 Here's the online help, as a reminder (`tracd --help`): 226 {{{ 227 Usage: tracd [options] [projenv] ... 228 229 Options: 230 --version show program's version number and exit 231 -h, --help show this help message and exit 232 -a DIGESTAUTH, --auth=DIGESTAUTH 233 [projectdir],[htdigest_file],[realm] 234 --basic-auth=BASICAUTH 235 [projectdir],[htpasswd_file],[realm] 236 -p PORT, --port=PORT the port number to bind to 237 -b HOSTNAME, --hostname=HOSTNAME 238 the host name or IP address to bind to 239 --protocol=PROTOCOL http|scgi|ajp|fcgi 240 -q, --unquote unquote PATH_INFO (may be needed when using ajp) 241 --http10 use HTTP/1.0 protocol version instead of HTTP/1.1 242 --http11 use HTTP/1.1 protocol version (default) 243 -e PARENTDIR, --env-parent-dir=PARENTDIR 244 parent directory of the project environments 245 --base-path=BASE_PATH 246 the initial portion of the request URL's "path" 247 -r, --auto-reload restart automatically when sources are modified 248 -s, --single-env only serve a single project without the project list 249 -d, --daemonize run in the background as a daemon 250 --pidfile=PIDFILE When daemonizing, file to which to write pid 251 --umask=MASK When daemonizing, file mode creation mask to use, in 252 octal notation (default 022) 253 }}} 254 255 Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 199 256 200 257 == Tips == … … 202 259 === Serving static content === 203 260 204 If `tracd` is the only web server used for the project,261 If `tracd` is the only web server used for the project, 205 262 it can also be used to distribute static content 206 263 (tarballs, Doxygen documentation, etc.) … … 211 268 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 212 269 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 213 which in turn can be written using the relative link syntax 214 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 215 216 Since 0.10, Trac supports a new `htdocs:` TracLinks 217 syntax for the above. With this, the example link above can be written simply 218 `htdocs:software-0.1.tar.gz`. 219 220 === Using apache rewrite rules === 221 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. 270 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). 271 272 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 273 274 === Using tracd behind a proxy 275 276 In some situations when you choose to use tracd behind Apache or another web server. 277 278 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. 279 280 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. 281 282 See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]. 283 284 === Authentication for tracd behind a proxy 285 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. 286 287 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. 288 289 First we bring tracd into Apache's location namespace. 290 291 {{{ 292 <Location /project/proxified> 293 Require ldap-group cn=somegroup, ou=Groups,dc=domain.com 294 Require ldap-user somespecificusertoo 295 ProxyPass http://localhost:8101/project/proxified/ 296 # Turns out we don't really need complicated RewriteRules here at all 297 RequestHeader set REMOTE_USER %{REMOTE_USER}s 298 </Location> 299 }}} 300 301 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: 302 {{{ 303 #!python 304 from trac.core import * 305 from trac.config import BoolOption 306 from trac.web.api import IAuthenticator 307 308 class MyRemoteUserAuthenticator(Component): 309 310 implements(IAuthenticator) 311 312 obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false', 313 """Whether the 'Remote-User:' HTTP header is to be trusted for user logins 314 (''since ??.??').""") 315 316 def authenticate(self, req): 317 if self.obey_remote_user_header and req.get_header('Remote-User'): 318 return req.get_header('Remote-User') 319 return None 320 321 }}} 322 323 Add this new parameter to your TracIni: 324 {{{ 325 ... 326 [trac] 327 ... 328 obey_remote_user_header = true 329 ... 330 }}} 331 332 Run tracd: 333 {{{ 334 tracd -p 8101 -r -s proxified --base-path=/project/proxified 335 }}} 222 336 223 337 === Serving a different base path than / === … … 228 342 229 343 ---- 230 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone ?version=13#RunningTracdasservice Running tracd.exe as a Windows service]344 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]
