Changes between Version 1 and Version 2 of TracStandalone
- Timestamp:
- Jan 16, 2015, 11:29:31 AM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v1 v2 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. 15 15 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 16 or [ http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.17 18 == Usage examples ==16 or [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. 17 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 Stric ly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.25 {{{ 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 {{{#!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) 97 96 97 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. 98 98 99 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. 99 100 100 101 The general format for using authentication is: 101 {{{ 102 {{{#!sh 102 103 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 103 104 }}} … … 115 116 Examples: 116 117 117 {{{ 118 {{{#!sh 118 119 $ tracd -p 8080 \ 119 120 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 … … 121 122 122 123 Of course, the password file can be be shared so that it is used for more than one project: 123 {{{ 124 {{{#!sh 124 125 $ tracd -p 8080 \ 125 126 --auth="project1,/path/to/passwordfile,mycompany.com" \ … … 129 130 130 131 Another way to share the password file is to specify "*" for the project name: 131 {{{ 132 {{{#!sh 132 133 $ tracd -p 8080 \ 133 134 --auth="*,/path/to/users.htdigest,mycompany.com" \ … … 135 136 }}} 136 137 137 === Basic Authorization: Using a htpasswd password file ===138 === Basic Authorization: Using a htpasswd password file 138 139 This section describes how to use `tracd` with Apache .htpasswd files. 139 140 … … 143 144 144 145 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 145 {{{ 146 {{{#!sh 146 147 $ sudo htpasswd -c /path/to/env/.htpasswd username 147 148 }}} 148 149 then for additional users: 149 {{{ 150 {{{#!sh 150 151 $ sudo htpasswd /path/to/env/.htpasswd username2 151 152 }}} 152 153 153 154 Then to start `tracd` run something like this: 154 {{{ 155 {{{#!sh 155 156 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 156 157 }}} 157 158 158 159 For example: 159 {{{ 160 {{{#!sh 160 161 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 161 162 }}} 162 163 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 163 164 164 === Digest authentication: Using a htdigest password file ===165 === Digest authentication: Using a htdigest password file 165 166 166 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. … … 168 169 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. 169 170 170 === Generating Passwords Without Apache ===171 === Generating Passwords Without Apache 171 172 172 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. … … 174 175 You can use this simple Python script to generate a '''digest''' password file: 175 176 176 {{{ 177 #!python 177 {{{#!python 178 178 from optparse import OptionParser 179 179 # The md5 module is deprecated in Python 2.5 … … 208 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): 209 209 210 {{{ 210 {{{#!sh 211 211 $ python trac-digest.py -u username -p password >> c:\digest.txt 212 212 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name … … 223 223 }}} 224 224 225 == Reference ==225 == Reference 226 226 227 227 Here's the online help, as a reminder (`tracd --help`): … … 259 259 Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 260 260 261 == Tips ==262 263 === Serving static content ===261 == Tips 262 263 === Serving static content 264 264 265 265 If `tracd` is the only web server used for the project, … … 272 272 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 273 273 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 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). 275 276 ''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). 277 275 278 276 === Using tracd behind a proxy … … 287 285 288 286 === Authentication for tracd behind a proxy 289 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. 290 288 291 289 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. … … 293 291 First we bring tracd into Apache's location namespace. 294 292 295 {{{ 293 {{{#!apache 296 294 <Location /project/proxified> 297 295 Require ldap-group cn=somegroup, ou=Groups,dc=domain.com … … 304 302 305 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: 306 {{{ 307 #!python 304 {{{#!python 308 305 from trac.core import * 309 306 from trac.config import BoolOption … … 326 323 327 324 Add this new parameter to your TracIni: 328 {{{ 329 ... 325 {{{#!ini 330 326 [trac] 331 327 ... … … 335 331 336 332 Run tracd: 337 {{{ 333 {{{#!sh 338 334 tracd -p 8101 -r -s proxified --base-path=/project/proxified 339 335 }}} … … 342 338 343 339 Global config (e.g. `/srv/trac/conf/trac.ini`): 344 {{{ 340 {{{#!ini 345 341 [components] 346 342 remote-user-auth.* = enabled … … 352 348 353 349 Environment config (e.g. `/srv/trac/envs/myenv`): 354 {{{ 350 {{{#!ini 355 351 [inherit] 356 352 file = /srv/trac/conf/trac.ini 357 353 }}} 358 354 359 === Serving a different base path than / ===355 === Serving a different base path than / 360 356 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 361 {{{ 357 {{{#!sh 362 358 $ tracd --base-path=/some/path 363 359 }}}
