Changes between Version 3 and Version 4 of TracStandalone
- Timestamp:
- 09/24/15 13:13:19 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v3 v4 1 ** Note: this page documents the version 1.0 of Trac, see [[0.12/TracStandalone]] if you need the previous version ** 2 = Tracd = 1 = Tracd 3 2 4 3 Tracd is a lightweight standalone Trac web server. 5 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. 6 5 7 == Pros ==6 == Pros 8 7 9 8 * Fewer dependencies: You don't need to install apache or any other web-server. … … 11 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). 12 11 13 == Cons ==12 == Cons 14 13 15 14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd. 16 15 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 17 or [ http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.18 19 == 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 20 19 21 20 A single project on port 8080. (http://localhost:8080/) 22 {{{ 21 {{{#!sh 23 22 $ tracd -p 8080 /path/to/project 24 23 }}} 25 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.26 {{{ 24 Strictly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use the `--hostname` option. 25 {{{#!sh 27 26 $ tracd --hostname=localhost -p 8080 /path/to/project 28 27 }}} 29 28 With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 30 {{{ 29 {{{#!sh 31 30 $ tracd -p 8080 /path/to/project1 /path/to/project2 32 31 }}} … … 36 35 37 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: 38 {{{ 37 {{{#!sh 39 38 $ tracd -p 8080 -e /path/to 40 39 }}} 41 40 42 To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}}will leave a Python process running in the background.43 44 == Installing as a Windows Service ==45 46 === 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 47 46 To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run: 48 {{{ 47 {{{#!cmd 49 48 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe 50 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>" … … 55 54 56 55 If you want tracd to start automatically when you boot Windows, do: 57 {{{ 56 {{{#!cmd 58 57 sc config tracd start= auto 59 58 }}} … … 75 74 76 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: 77 {{{ 76 {{{#!cmd 78 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>" 79 80 78 net start tracd 81 79 }}} 82 80 83 === Option 2 ===81 === Option 2 84 82 85 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. 86 84 87 === Option 3 ===85 === Option 3 88 86 89 87 also cygwin's cygrunsrv.exe can be used: 90 {{{ 88 {{{#!sh 91 89 $ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects' 92 90 $ net start tracd 93 91 }}} 94 92 95 == Using Authentication == 93 == Using Authentication 94 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) 96 97 {{{#!div style="border: 1pt dotted; margin: 1em" 98 **Attention:** 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, or HFS+ on OSX). 99 }}} 96 100 97 101 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. 98 102 99 103 The general format for using authentication is: 100 {{{ 104 {{{#!sh 101 105 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 102 106 }}} … … 114 118 Examples: 115 119 116 {{{ 120 {{{#!sh 117 121 $ tracd -p 8080 \ 118 122 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 … … 120 124 121 125 Of course, the password file can be be shared so that it is used for more than one project: 122 {{{ 126 {{{#!sh 123 127 $ tracd -p 8080 \ 124 128 --auth="project1,/path/to/passwordfile,mycompany.com" \ … … 128 132 129 133 Another way to share the password file is to specify "*" for the project name: 130 {{{ 134 {{{#!sh 131 135 $ tracd -p 8080 \ 132 136 --auth="*,/path/to/users.htdigest,mycompany.com" \ … … 134 138 }}} 135 139 136 === Basic Authorization: Using a htpasswd password file ===140 === Basic Authorization: Using a htpasswd password file 137 141 This section describes how to use `tracd` with Apache .htpasswd files. 138 142 … … 142 146 143 147 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 144 {{{ 148 {{{#!sh 145 149 $ sudo htpasswd -c /path/to/env/.htpasswd username 146 150 }}} 147 151 then for additional users: 148 {{{ 152 {{{#!sh 149 153 $ sudo htpasswd /path/to/env/.htpasswd username2 150 154 }}} 151 155 152 156 Then to start `tracd` run something like this: 153 {{{ 154 $ tracd -p 8080 --basic-auth="project dirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname157 {{{#!sh 158 $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project 155 159 }}} 156 160 157 161 For example: 158 {{{ 159 $ tracd -p 8080 --basic-auth=" testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv162 {{{#!sh 163 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project 160 164 }}} 161 165 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 162 166 163 === Digest authentication: Using a htdigest password file ===167 === Digest authentication: Using a htdigest password file 164 168 165 169 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. … … 167 171 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. 168 172 169 === Generating Passwords Without Apache === 170 171 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. 172 173 You can use this simple Python script to generate a '''digest''' password file: 174 175 {{{ 176 #!python 177 from optparse import OptionParser 178 # The md5 module is deprecated in Python 2.5 179 try: 180 from hashlib import md5 181 except ImportError: 182 from md5 import md5 183 realm = 'trac' 184 185 # build the options 186 usage = "usage: %prog [options]" 187 parser = OptionParser(usage=usage) 188 parser.add_option("-u", "--username",action="store", dest="username", type = "string", 189 help="the username for whom to generate a password") 190 parser.add_option("-p", "--password",action="store", dest="password", type = "string", 191 help="the password to use") 192 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string", 193 help="the realm in which to create the digest") 194 (options, args) = parser.parse_args() 195 196 # check options 197 if (options.username is None) or (options.password is None): 198 parser.error("You must supply both the username and password") 199 if (options.realm is not None): 200 realm = options.realm 201 202 # Generate the string to enter into the htdigest file 203 kd = lambda x: md5(':'.join(x)).hexdigest() 204 print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 205 }}} 206 207 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): 208 209 {{{ 210 $ python trac-digest.py -u username -p password >> c:\digest.txt 211 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 173 === Generating Passwords Without Apache 174 175 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 177 Trac also provides `htpasswd` and `htdigest` scripts in `contrib`: 178 {{{#!sh 179 $ ./contrib/htpasswd.py -cb htpasswd user1 user1 180 $ ./contrib/htpasswd.py -b htpasswd user2 user2 181 }}} 182 183 {{{#!sh 184 $ ./contrib/htdigest.py -cb htdigest trac user1 user1 185 $ ./contrib/htdigest.py -b htdigest trac user2 user2 212 186 }}} 213 187 214 188 ==== Using `md5sum` 215 189 It is possible to use `md5sum` utility to generate digest-password file: 216 {{{ 190 {{{#!sh 217 191 user= 218 192 realm= … … 222 196 }}} 223 197 224 == Reference ==198 == Reference 225 199 226 200 Here's the online help, as a reminder (`tracd --help`): … … 258 232 Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 259 233 260 == Tips ==261 262 === Serving static content ===234 == Tips 235 236 === Serving static content 263 237 264 238 If `tracd` is the only web server used for the project, … … 271 245 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 272 246 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 273 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). 274 275 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 247 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). 276 248 277 249 === Using tracd behind a proxy … … 286 258 287 259 === Authentication for tracd behind a proxy 288 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.260 It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. There is some discussion about this in [trac:#9206]. 289 261 290 262 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. … … 292 264 First we bring tracd into Apache's location namespace. 293 265 294 {{{ 266 {{{#!apache 295 267 <Location /project/proxified> 296 268 Require ldap-group cn=somegroup, ou=Groups,dc=domain.com … … 303 275 304 276 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: 305 {{{ 306 #!python 277 {{{#!python 307 278 from trac.core import * 308 279 from trac.config import BoolOption … … 325 296 326 297 Add this new parameter to your TracIni: 327 {{{ 328 ... 298 {{{#!ini 329 299 [trac] 330 300 ... … … 334 304 335 305 Run tracd: 336 {{{ 337 tracd -p 8101 - r -s proxified --base-path=/project/proxified306 {{{#!sh 307 tracd -p 8101 -s proxified --base-path=/project/proxified 338 308 }}} 339 309 … … 341 311 342 312 Global config (e.g. `/srv/trac/conf/trac.ini`): 343 {{{ 313 {{{#!ini 344 314 [components] 345 315 remote-user-auth.* = enabled … … 351 321 352 322 Environment config (e.g. `/srv/trac/envs/myenv`): 353 {{{ 323 {{{#!ini 354 324 [inherit] 355 325 file = /srv/trac/conf/trac.ini 356 326 }}} 357 327 358 === Serving a different base path than / ===328 === Serving a different base path than / 359 329 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 360 {{{ 330 {{{#!sh 361 331 $ tracd --base-path=/some/path 362 332 }}}
