Changes between Version 2 and Version 3 of TracStandalone
- Timestamp:
- 09/14/17 14:50:26 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v2 v3 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 the `--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 == 95 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) 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 }}} 97 100 98 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. 99 102 100 103 The general format for using authentication is: 101 {{{ 104 {{{#!sh 102 105 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 103 106 }}} … … 115 118 Examples: 116 119 117 {{{ 120 {{{#!sh 118 121 $ tracd -p 8080 \ 119 122 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 … … 121 124 122 125 Of course, the password file can be be shared so that it is used for more than one project: 123 {{{ 126 {{{#!sh 124 127 $ tracd -p 8080 \ 125 128 --auth="project1,/path/to/passwordfile,mycompany.com" \ … … 129 132 130 133 Another way to share the password file is to specify "*" for the project name: 131 {{{ 134 {{{#!sh 132 135 $ tracd -p 8080 \ 133 136 --auth="*,/path/to/users.htdigest,mycompany.com" \ … … 135 138 }}} 136 139 137 === Basic Authorization: Using a htpasswd password file ===140 === Basic Authorization: Using a htpasswd password file 138 141 This section describes how to use `tracd` with Apache .htpasswd files. 139 142 140 Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to141 decode some htpasswd formats. Trac source code attempt an `import crypt` first, but there142 is no such package for Python 2.6. Only `SHA-1` passwords (since Trac 1.0)work without this module.143 Note: On Windows It is necessary to install the [https://pypi.python.org/pypi/passlib passlib] 144 package in order to decode some htpasswd formats. Only `SHA-1` passwords (since Trac 1.0) 145 work without this module. 143 146 144 147 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 145 {{{ 148 {{{#!sh 146 149 $ sudo htpasswd -c /path/to/env/.htpasswd username 147 150 }}} 148 151 then for additional users: 149 {{{ 152 {{{#!sh 150 153 $ sudo htpasswd /path/to/env/.htpasswd username2 151 154 }}} 152 155 153 156 Then to start `tracd` run something like this: 154 {{{ 155 $ 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 156 159 }}} 157 160 158 161 For example: 159 {{{ 160 $ 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 161 164 }}} 162 165 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 163 166 164 === Digest authentication: Using a htdigest password file ===167 === Digest authentication: Using a htdigest password file 165 168 166 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. … … 168 171 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. 169 172 170 === Generating Passwords Without Apache === 171 172 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. 173 174 You can use this simple Python script to generate a '''digest''' password file: 175 176 {{{ 177 #!python 178 from optparse import OptionParser 179 # The md5 module is deprecated in Python 2.5 180 try: 181 from hashlib import md5 182 except ImportError: 183 from md5 import md5 184 realm = 'trac' 185 186 # build the options 187 usage = "usage: %prog [options]" 188 parser = OptionParser(usage=usage) 189 parser.add_option("-u", "--username",action="store", dest="username", type = "string", 190 help="the username for whom to generate a password") 191 parser.add_option("-p", "--password",action="store", dest="password", type = "string", 192 help="the password to use") 193 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string", 194 help="the realm in which to create the digest") 195 (options, args) = parser.parse_args() 196 197 # check options 198 if (options.username is None) or (options.password is None): 199 parser.error("You must supply both the username and password") 200 if (options.realm is not None): 201 realm = options.realm 202 203 # Generate the string to enter into the htdigest file 204 kd = lambda x: md5(':'.join(x)).hexdigest() 205 print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 206 }}} 207 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 210 {{{ 211 $ python trac-digest.py -u username -p password >> c:\digest.txt 212 $ 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 213 186 }}} 214 187 215 188 ==== Using `md5sum` 216 189 It is possible to use `md5sum` utility to generate digest-password file: 217 {{{ 190 {{{#!sh 218 191 user= 219 192 realm= … … 223 196 }}} 224 197 225 == Reference ==198 == Reference 226 199 227 200 Here's the online help, as a reminder (`tracd --help`): … … 259 232 Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 260 233 261 == Tips ==262 263 === Serving static content ===234 == Tips 235 236 === Serving static content 264 237 265 238 If `tracd` is the only web server used for the project, … … 272 245 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 273 246 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'' 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). 277 248 278 249 === Using tracd behind a proxy … … 287 258 288 259 === 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.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]. 290 261 291 262 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. … … 293 264 First we bring tracd into Apache's location namespace. 294 265 295 {{{ 266 {{{#!apache 296 267 <Location /project/proxified> 297 268 Require ldap-group cn=somegroup, ou=Groups,dc=domain.com … … 304 275 305 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: 306 {{{ 307 #!python 277 {{{#!python 308 278 from trac.core import * 309 279 from trac.config import BoolOption … … 326 296 327 297 Add this new parameter to your TracIni: 328 {{{ 329 ... 298 {{{#!ini 330 299 [trac] 331 300 ... … … 335 304 336 305 Run tracd: 337 {{{ 338 tracd -p 8101 - r -s proxified --base-path=/project/proxified306 {{{#!sh 307 tracd -p 8101 -s proxified --base-path=/project/proxified 339 308 }}} 340 309 … … 342 311 343 312 Global config (e.g. `/srv/trac/conf/trac.ini`): 344 {{{ 313 {{{#!ini 345 314 [components] 346 315 remote-user-auth.* = enabled … … 352 321 353 322 Environment config (e.g. `/srv/trac/envs/myenv`): 354 {{{ 323 {{{#!ini 355 324 [inherit] 356 325 file = /srv/trac/conf/trac.ini 357 326 }}} 358 327 359 === Serving a different base path than / ===328 === Serving a different base path than / 360 329 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 361 {{{ 330 {{{#!sh 362 331 $ tracd --base-path=/some/path 363 332 }}}