Changes between Version 1 and Version 2 of TracStandalone
- Timestamp:
- Jul 5, 2024, 1:11:32 PM (5 months 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 ==7 8 * Fewer dependencies: You don't need to install apache or any other web-server.9 * Fast: Should be almost as fast as the [wiki:TracMod Python 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 default10 * 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 12 == Cons ==6 == Pros 7 8 * Fewer dependencies: You don't need to install Apache or any other web-server. 9 * Fast: Should be almost as fast as the [wiki:TracModWSGI mod_wsgi] version (and much faster than the [wiki:TracCgi CGI]), especially since the HTTP/1.1 version of the protocol is enabled by default. 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, for example in Trac itself or in a plugin. 11 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 * 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 == 15 16 == Usage examples 19 17 20 18 A single project on port 8080. (http://localhost:8080/) 21 {{{ 19 {{{#!sh 22 20 $ tracd -p 8080 /path/to/project 23 21 }}} 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 {{{ 22 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. 23 {{{#!sh 26 24 $ tracd --hostname=localhost -p 8080 /path/to/project 27 25 }}} 28 26 With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 29 {{{ 27 {{{#!sh 30 28 $ tracd -p 8080 /path/to/project1 /path/to/project2 31 29 }}} 32 30 33 You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the 34 different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project. 31 You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project. 35 32 36 33 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 {{{ 34 {{{#!sh 38 35 $ tracd -p 8080 -e /path/to 39 36 }}} 40 37 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 To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run: 47 {{{ 38 There is support for the HTTPS protocol (//Since 1.3.4//). Specify the path to the PEM certificate file and keyfile using the `--certfile` and `--keyfile` options. You can specify just the `--certfile` option if you have a [https://docs.python.org/2/library/ssl.html#combined-key-and-certificate combined key and certificate]. 39 40 To exit the server on Windows, be sure to use `CTRL-BREAK`. Using `CTRL-C` will leave a Python process running in the background. 41 42 == Installing as a Windows Service 43 44 === Option 1 45 46 To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run: 47 {{{#!cmd 48 48 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe 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>"49 reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\tracd.exe\" <your tracd parameters>" 50 50 net start tracd 51 51 }}} 52 52 53 '''DO NOT''' use {{{tracd.exe}}}. Instead register {{{python.exe}}} directly with {{{tracd-script.py}}} as a parameter. If you use {{{tracd.exe}}}, it will spawn the python process without SRVANY's knowledge. This python process will survive a {{{net stop tracd}}}. 53 {{{#!div style="border: 1pt dotted; margin: 1em;" 54 **Attention:** Do not use `tracd.exe` directly. Instead register `python.exe` directly with `tracd.exe` as a parameter. If you use `tracd.exe`, it will spawn the Python process without SRVANY's knowledge. This Python process will survive a `net stop tracd`. 55 }}} 54 56 55 57 If you want tracd to start automatically when you boot Windows, do: 56 {{{ 58 {{{#!cmd 57 59 sc config tracd start= auto 58 60 }}} … … 65 67 66 68 Three (string) parameters are provided: 67 ||!AppDirectory ||C:\Python2 6\ ||69 ||!AppDirectory ||C:\Python27\ || 68 70 ||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 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 {{{ 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 71 ||!AppParameters ||scripts\tracd.exe -p 8080 ... || 72 73 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. 74 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. 75 }}} 76 77 For Windows 7 User, srvany.exe may not be an option, so you can use [https://www.google.com/search?q=winserv.exe WINSERV] utility and run: 78 {{{#!cmd 79 "C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd.exe <your tracd parameters>" 79 80 net start tracd 80 81 }}} 81 82 82 === Option 2 ===83 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.85 86 === Option 3 ===83 === Option 2 84 85 Use [https://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [https://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 86 87 === Option 3 87 88 88 89 also cygwin's cygrunsrv.exe can be used: 89 {{{ 90 {{{#!sh 90 91 $ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects' 91 92 $ net start tracd 92 93 }}} 93 94 94 == Using Authentication == 95 == Using Authentication 96 97 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. 98 99 {{{#!div style="border: 1pt dotted; margin: 1em" 100 **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). 101 }}} 95 102 96 103 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 104 98 105 The general format for using authentication is: 99 {{{ 106 {{{#!sh 100 107 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 101 108 }}} … … 113 120 Examples: 114 121 115 {{{ 122 {{{#!sh 116 123 $ tracd -p 8080 \ 117 124 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 … … 119 126 120 127 Of course, the password file can be be shared so that it is used for more than one project: 121 {{{ 128 {{{#!sh 122 129 $ tracd -p 8080 \ 123 130 --auth="project1,/path/to/passwordfile,mycompany.com" \ … … 127 134 128 135 Another way to share the password file is to specify "*" for the project name: 129 {{{ 136 {{{#!sh 130 137 $ tracd -p 8080 \ 131 138 --auth="*,/path/to/users.htdigest,mycompany.com" \ … … 133 140 }}} 134 141 135 === Basic Authorization: Using a htpasswd password file === 142 === Basic Authorization: Using a htpasswd password file 143 136 144 This section describes how to use `tracd` with Apache .htpasswd files. 137 145 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. 146 '''Note''': On Windows It is necessary to install the [https://pypi.python.org/pypi/passlib passlib] package in order to decode some htpasswd formats. Only `SHA-1` passwords (since Trac 1.0) work without this module. 141 147 142 148 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 143 {{{ 149 {{{#!sh 144 150 $ sudo htpasswd -c /path/to/env/.htpasswd username 145 151 }}} 146 152 then for additional users: 147 {{{ 153 {{{#!sh 148 154 $ sudo htpasswd /path/to/env/.htpasswd username2 149 155 }}} 150 156 151 157 Then to start `tracd` run something like this: 152 {{{ 153 $ tracd -p 8080 --basic-auth="project dirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname158 {{{#!sh 159 $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project 154 160 }}} 155 161 156 162 For example: 157 {{{ 158 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 159 }}} 160 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 161 162 === Digest authentication: Using a htdigest password file === 163 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. 165 166 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 167 168 === Generating Passwords Without Apache === 169 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: 173 174 {{{ 175 #!python 176 from optparse import OptionParser 177 # The md5 module is deprecated in Python 2.5 178 try: 179 from hashlib import md5 180 except ImportError: 181 from md5 import md5 182 realm = 'trac' 183 184 # build the options 185 usage = "usage: %prog [options]" 186 parser = OptionParser(usage=usage) 187 parser.add_option("-u", "--username",action="store", dest="username", type = "string", 188 help="the username for whom to generate a password") 189 parser.add_option("-p", "--password",action="store", dest="password", type = "string", 190 help="the password to use") 191 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string", 192 help="the realm in which to create the digest") 193 (options, args) = parser.parse_args() 194 195 # check options 196 if (options.username is None) or (options.password is None): 197 parser.error("You must supply both the username and password") 198 if (options.realm is not None): 199 realm = options.realm 200 201 # Generate the string to enter into the htdigest file 202 kd = lambda x: md5(':'.join(x)).hexdigest() 203 print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 204 }}} 205 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): 207 208 {{{ 209 $ python trac-digest.py -u username -p password >> c:\digest.txt 210 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 163 {{{#!sh 164 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project 165 }}} 166 167 '''Note:''' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 168 169 === Digest authentication: Using a htdigest password file 170 171 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 [https://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. 172 173 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. 174 175 === Generating Passwords Without Apache 176 177 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. 178 179 Trac also provides `htpasswd` and `htdigest` scripts in [https://trac.edgewall.org/browser/trunk/contrib contrib] (also available in the tar or zip archive): 180 {{{#!sh 181 $ ./contrib/htpasswd.py -cb htpasswd user1 user1 182 $ ./contrib/htpasswd.py -b htpasswd user2 user2 183 }}} 184 185 {{{#!sh 186 $ ./contrib/htdigest.py -cb htdigest trac user1 user1 187 $ ./contrib/htdigest.py -b htdigest trac user2 user2 211 188 }}} 212 189 213 190 ==== Using `md5sum` 191 214 192 It is possible to use `md5sum` utility to generate digest-password file: 215 {{{ 193 {{{#!sh 216 194 user= 217 195 realm= … … 221 199 }}} 222 200 223 == Reference ==224 225 Here's the online help, as a reminder (`tracd - -help`):201 == Reference 202 203 Here's the online help, as a reminder (`tracd -h` or `tracd --help`): 226 204 {{{ 227 Usage: tracd [options] [projenv] ... 228 229 Options: 205 usage: tracd [-h] [--version] [-e PARENTDIR | -s] 206 [-a DIGESTAUTH | --basic-auth BASICAUTH] [-p PORT] [-b HOSTNAME] 207 [--protocol {http,https,scgi,ajp,fcgi}] [--certfile CERTFILE] 208 [--keyfile KEYFILE] [-q] [--base-path BASE_PATH] 209 [--http10 | --http11] [-r | -d] [--pidfile PIDFILE] [--umask MASK] 210 [--group GROUP] [--user USER] 211 [envs ...] 212 213 positional arguments: 214 envs path of the project environment(s) 215 216 options: 217 -h, --help show this help message and exit 230 218 --version show program's version number and exit 231 -h, --help show this help message and exit 232 -a DIGESTAUTH, --auth=DIGESTAUTH 219 -e PARENTDIR, --env-parent-dir PARENTDIR 220 parent directory of the project environments 221 -s, --single-env only serve a single project without the project list 222 -a DIGESTAUTH, --auth DIGESTAUTH 233 223 [projectdir],[htdigest_file],[realm] 234 --basic-auth =BASICAUTH224 --basic-auth BASICAUTH 235 225 [projectdir],[htpasswd_file],[realm] 236 -p PORT, --port =PORT the port number to bind to237 -b HOSTNAME, --hostname =HOSTNAME226 -p PORT, --port PORT the port number to bind to 227 -b HOSTNAME, --hostname HOSTNAME 238 228 the host name or IP address to bind to 239 --protocol =PROTOCOL http|scgi|ajp|fcgi240 -q, --unquote unquote PATH_INFO (may be needed when using ajp)241 -- http10 use HTTP/1.0 protocol version instead of HTTP/1.1242 -- http11 use HTTP/1.1 protocol version (default)243 - e PARENTDIR, --env-parent-dir=PARENTDIR244 p arent directory of the project environments245 --base-path =BASE_PATH229 --protocol {http,https,scgi,ajp,fcgi} 230 the server protocol (default: http) 231 --certfile CERTFILE PEM certificate file for HTTPS 232 --keyfile KEYFILE PEM key file for HTTPS 233 -q, --unquote unquote PATH_INFO (may be needed when using the ajp 234 protocol) 235 --base-path BASE_PATH 246 236 the initial portion of the request URL's "path" 237 --http10 use HTTP/1.0 protocol instead of HTTP/1.1 238 --http11 use HTTP/1.1 protocol (default) 247 239 -r, --auto-reload restart automatically when sources are modified 248 -s, --single-env only serve a single project without the project list249 240 -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) 241 --pidfile PIDFILE file to write pid when daemonizing 242 --umask MASK when daemonizing, file mode creation mask to use, in 243 octal notation (default: 022) 244 --group GROUP the group to run as 245 --user USER the user to run as 253 246 }}} 254 247 255 248 Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started. 256 249 257 == Tips == 258 259 === Serving static content === 260 261 If `tracd` is the only web server used for the project, 262 it can also be used to distribute static content 263 (tarballs, Doxygen documentation, etc.) 264 265 This static content should be put in the `$TRAC_ENV/htdocs` folder, 266 and is accessed by URLs like `<project_URL>/chrome/site/...`. 267 268 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 269 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 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'' 250 == Tips 251 252 === Serving static content 253 254 If `tracd` is the only web server used for the project, it can also be used to distribute static content, such as tarballs, Doxygen documentation, etc. 255 256 This static content should be put in the `$TRAC_ENV/htdocs` folder, and is accessed by URLs like `<project_URL>/chrome/site/...`. 257 258 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 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). 273 259 274 260 === Using tracd behind a proxy … … 283 269 284 270 === 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. 271 272 It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. See also [trac:#9206]. 286 273 287 274 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. … … 289 276 First we bring tracd into Apache's location namespace. 290 277 291 {{{ 278 {{{#!apache 292 279 <Location /project/proxified> 293 280 Require ldap-group cn=somegroup, ou=Groups,dc=domain.com … … 300 287 301 288 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 289 {{{#!python 304 290 from trac.core import * 305 291 from trac.config import BoolOption … … 310 296 implements(IAuthenticator) 311 297 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 ??.??').""") 298 obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false', 299 """Whether the 'Remote-User:' HTTP header is to be trusted for user logins 300 (''since ??.??').""") 315 301 316 302 def authenticate(self, req): 317 if self.obey_remote_user_header and req.get_header('Remote-User'): 318 return req.get_header('Remote-User') 303 if self.obey_remote_user_header and req.get_header('Remote-User'): 304 return req.get_header('Remote-User') 319 305 return None 320 306 … … 322 308 323 309 Add this new parameter to your TracIni: 324 {{{ 325 ... 310 {{{#!ini 326 311 [trac] 327 312 ... … … 331 316 332 317 Run tracd: 333 {{{ 334 tracd -p 8101 -r -s proxified --base-path=/project/proxified 335 }}} 336 337 === Serving a different base path than / === 338 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 339 {{{ 318 {{{#!sh 319 tracd -p 8101 -s proxified --base-path=/project/proxified 320 }}} 321 322 Note that if you want to install this plugin for all projects, you have to put it in your [TracPlugins#Plugindiscovery global plugins_directory] and enable it in your global `trac.ini`. 323 324 Global config (e.g. `/srv/trac/conf/trac.ini`): 325 {{{#!ini 326 [components] 327 remote-user-auth.* = enabled 328 [inherit] 329 plugins_dir = /srv/trac/plugins 330 [trac] 331 obey_remote_user_header = true 332 }}} 333 334 Environment config (e.g. `/srv/trac/envs/myenv`): 335 {{{#!ini 336 [inherit] 337 file = /srv/trac/conf/trac.ini 338 }}} 339 340 === Serving a different base path than / 341 342 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is: 343 {{{#!sh 340 344 $ tracd --base-path=/some/path 341 345 }}}