![(please configure the [header_logo] section in trac.ini)](/chrome/site/cardinal.gif)
Changes between Version 4 and Version 5 of TracStandalone
- Timestamp:
- 01/28/15 17:06:11 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v4 v5 1 = Tracd =1 = Tracd 2 2 3 3 Tracd is a lightweight standalone Trac web server. 4 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. 5 5 6 == Pros ==6 == Pros 7 7 8 8 * Fewer dependencies: You don't need to install apache or any other web-server. … … 10 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). 11 11 12 == Cons ==12 == Cons 13 13 14 14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd. … … 16 16 or [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. 17 17 18 == Usage examples ==18 == Usage examples 19 19 20 20 A single project on port 8080. (http://localhost:8080/) 21 {{{ 21 {{{#!sh 22 22 $ tracd -p 8080 /path/to/project 23 23 }}} 24 24 Strictly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option. 25 {{{ 25 {{{#!sh 26 26 $ tracd --hostname=localhost -p 8080 /path/to/project 27 27 }}} 28 28 With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 29 {{{ 29 {{{#!sh 30 30 $ tracd -p 8080 /path/to/project1 /path/to/project2 31 31 }}} … … 35 35 36 36 An alternative way to serve multiple projects is to specify a parent directory in which each subdirectory is a Trac project, using the `-e` option. The example above could be rewritten: 37 {{{ 37 {{{#!sh 38 38 $ tracd -p 8080 -e /path/to 39 39 }}} 40 40 41 To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}}will leave a Python process running in the background.42 43 == Installing as a Windows Service ==44 45 === Option 1 ===41 To exit the server on Windows, be sure to use `CTRL-BREAK` -- using `CTRL-C` will leave a Python process running in the background. 42 43 == Installing as a Windows Service 44 45 === Option 1 46 46 To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run: 47 {{{ 47 {{{#!cmd 48 48 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe 49 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>" … … 54 54 55 55 If you want tracd to start automatically when you boot Windows, do: 56 {{{ 56 {{{#!cmd 57 57 sc config tracd start= auto 58 58 }}} … … 74 74 75 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 {{{ 76 {{{#!cmd 77 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 78 net start tracd 80 79 }}} 81 80 82 === Option 2 ===81 === Option 2 83 82 84 83 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 84 86 === Option 3 ===85 === Option 3 87 86 88 87 also cygwin's cygrunsrv.exe can be used: 89 {{{ 88 {{{#!sh 90 89 $ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects' 91 90 $ net start tracd 92 91 }}} 93 92 94 == Using Authentication ==93 == Using Authentication 95 94 96 95 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) … … 101 100 102 101 The general format for using authentication is: 103 {{{ 102 {{{#!sh 104 103 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 105 104 }}} … … 117 116 Examples: 118 117 119 {{{ 118 {{{#!sh 120 119 $ tracd -p 8080 \ 121 120 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 … … 123 122 124 123 Of course, the password file can be be shared so that it is used for more than one project: 125 {{{ 124 {{{#!sh 126 125 $ tracd -p 8080 \ 127 126 --auth="project1,/path/to/passwordfile,mycompany.com" \ … … 131 130 132 131 Another way to share the password file is to specify "*" for the project name: 133 {{{ 132 {{{#!sh 134 133 $ tracd -p 8080 \ 135 134 --auth="*,/path/to/users.htdigest,mycompany.com" \ … … 137 136 }}} 138 137 139 === Basic Authorization: Using a htpasswd password file ===138 === Basic Authorization: Using a htpasswd password file 140 139 This section describes how to use `tracd` with Apache .htpasswd files. 141 140 … … 145 144 146 145 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 147 {{{ 146 {{{#!sh 148 147 $ sudo htpasswd -c /path/to/env/.htpasswd username 149 148 }}} 150 149 then for additional users: 151 {{{ 150 {{{#!sh 152 151 $ sudo htpasswd /path/to/env/.htpasswd username2 153 152 }}} 154 153 155 154 Then to start `tracd` run something like this: 156 {{{ 155 {{{#!sh 157 156 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 158 157 }}} 159 158 160 159 For example: 161 {{{ 160 {{{#!sh 162 161 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 163 162 }}} 164 163 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 165 164 166 === Digest authentication: Using a htdigest password file ===165 === Digest authentication: Using a htdigest password file 167 166 168 167 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. … … 170 169 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. 171 170 172 === Generating Passwords Without Apache ===171 === Generating Passwords Without Apache 173 172 174 173 Basic 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. … … 176 175 You can use this simple Python script to generate a '''digest''' password file: 177 176 178 {{{ 179 #!python 177 {{{#!python 180 178 from optparse import OptionParser 181 179 # The md5 module is deprecated in Python 2.5 … … 210 208 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 209 212 {{{ 210 {{{#!sh 213 211 $ python trac-digest.py -u username -p password >> c:\digest.txt 214 212 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name … … 225 223 }}} 226 224 227 == Reference ==225 == Reference 228 226 229 227 Here's the online help, as a reminder (`tracd --help`): … … 261 259 Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 262 260 263 == Tips ==264 265 === Serving static content ===261 == Tips 262 263 === Serving static content 266 264 267 265 If `tracd` is the only web server used for the project, … … 274 272 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 275 273 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 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'' 274 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). 279 275 280 276 === Using tracd behind a proxy … … 289 285 290 286 === 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.287 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 288 293 289 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. … … 295 291 First we bring tracd into Apache's location namespace. 296 292 297 {{{ 293 {{{#!apache 298 294 <Location /project/proxified> 299 295 Require ldap-group cn=somegroup, ou=Groups,dc=domain.com … … 306 302 307 303 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 304 {{{#!python 310 305 from trac.core import * 311 306 from trac.config import BoolOption … … 328 323 329 324 Add this new parameter to your TracIni: 330 {{{ 331 ... 325 {{{#!ini 332 326 [trac] 333 327 ... … … 337 331 338 332 Run tracd: 339 {{{ 333 {{{#!sh 340 334 tracd -p 8101 -r -s proxified --base-path=/project/proxified 341 335 }}} … … 344 338 345 339 Global config (e.g. `/srv/trac/conf/trac.ini`): 346 {{{ 340 {{{#!ini 347 341 [components] 348 342 remote-user-auth.* = enabled … … 354 348 355 349 Environment config (e.g. `/srv/trac/envs/myenv`): 356 {{{ 350 {{{#!ini 357 351 [inherit] 358 352 file = /srv/trac/conf/trac.ini 359 353 }}} 360 354 361 === Serving a different base path than / ===355 === Serving a different base path than / 362 356 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 363 {{{ 357 {{{#!sh 364 358 $ tracd --base-path=/some/path 365 359 }}}
