Changes between Version 2 and Version 3 of TracStandalone
- Timestamp:
- 03/13/22 22:11:41 (3 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v2 v3 39 39 }}} 40 40 41 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]. 42 41 43 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 44 … … 44 46 45 47 === Option 1 46 To install as a Windows service, get the [http ://www.google.com/search?q=srvany.exe SRVANY] utility and run:48 To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run: 47 49 {{{#!cmd 48 50 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>"51 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 52 net start tracd 51 53 }}} 52 54 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}}}. 55 {{{#!div style="border: 1pt dotted; margin: 1em;" 56 **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`. 57 }}} 54 58 55 59 If you want tracd to start automatically when you boot Windows, do: … … 65 69 66 70 Three (string) parameters are provided: 67 ||!AppDirectory ||C:\Python2 6\ ||71 ||!AppDirectory ||C:\Python27\ || 68 72 ||Application ||python.exe || 69 ||!AppParameters ||scripts\tracd -script.py-p 8080 ... ||73 ||!AppParameters ||scripts\tracd.exe -p 8080 ... || 70 74 71 75 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. … … 73 77 }}} 74 78 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:79 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: 76 80 {{{#!cmd 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>"81 "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>" 78 82 net start tracd 79 83 }}} … … 81 85 === Option 2 82 86 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.87 Use [https://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [https://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 84 88 85 89 === Option 3 … … 167 171 === Digest authentication: Using a htdigest password file 168 172 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.173 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. 170 174 171 175 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error. … … 198 202 == Reference 199 203 200 Here's the online help, as a reminder (`tracd - -help`):204 Here's the online help, as a reminder (`tracd -h` or `tracd --help`): 201 205 {{{ 202 Usage: tracd [options] [projenv] ... 203 204 Options: 206 usage: tracd [-h] [--version] [-e PARENTDIR | -s] 207 [-a DIGESTAUTH | --basic-auth BASICAUTH] [-p PORT] [-b HOSTNAME] 208 [--protocol {http,https,scgi,ajp,fcgi}] [--certfile CERTFILE] 209 [--keyfile KEYFILE] [-q] [--base-path BASE_PATH] 210 [--http10 | --http11] [-r | -d] [--pidfile PIDFILE] [--umask MASK] 211 [--group GROUP] [--user USER] 212 [envs ...] 213 214 positional arguments: 215 envs path of the project environment(s) 216 217 optional arguments: 218 -h, --help show this help message and exit 205 219 --version show program's version number and exit 206 -h, --help show this help message and exit 207 -a DIGESTAUTH, --auth=DIGESTAUTH 220 -e PARENTDIR, --env-parent-dir PARENTDIR 221 parent directory of the project environments 222 -s, --single-env only serve a single project without the project list 223 -a DIGESTAUTH, --auth DIGESTAUTH 208 224 [projectdir],[htdigest_file],[realm] 209 --basic-auth =BASICAUTH225 --basic-auth BASICAUTH 210 226 [projectdir],[htpasswd_file],[realm] 211 -p PORT, --port =PORT the port number to bind to212 -b HOSTNAME, --hostname =HOSTNAME227 -p PORT, --port PORT the port number to bind to 228 -b HOSTNAME, --hostname HOSTNAME 213 229 the host name or IP address to bind to 214 --protocol =PROTOCOL http|scgi|ajp|fcgi215 -q, --unquote unquote PATH_INFO (may be needed when using ajp)216 -- http10 use HTTP/1.0 protocol version instead of HTTP/1.1217 -- http11 use HTTP/1.1 protocol version (default)218 - e PARENTDIR, --env-parent-dir=PARENTDIR219 p arent directory of the project environments220 --base-path =BASE_PATH230 --protocol {http,https,scgi,ajp,fcgi} 231 the server protocol (default: http) 232 --certfile CERTFILE PEM certificate file for HTTPS 233 --keyfile KEYFILE PEM key file for HTTPS 234 -q, --unquote unquote PATH_INFO (may be needed when using the ajp 235 protocol) 236 --base-path BASE_PATH 221 237 the initial portion of the request URL's "path" 238 --http10 use HTTP/1.0 protocol instead of HTTP/1.1 239 --http11 use HTTP/1.1 protocol (default) 222 240 -r, --auto-reload restart automatically when sources are modified 223 -s, --single-env only serve a single project without the project list224 241 -d, --daemonize run in the background as a daemon 225 --pidfile =PIDFILE when daemonizing, file to which to write pid226 --umask =MASK when daemonizing, file mode creation mask to use, in227 octal notation (default 022)228 --group =GROUP the group to run as229 --user =USER the user to run as242 --pidfile PIDFILE file to write pid when daemonizing 243 --umask MASK when daemonizing, file mode creation mask to use, in 244 octal notation (default: 022) 245 --group GROUP the group to run as 246 --user USER the user to run as 230 247 }}} 231 248 … … 236 253 === Serving static content 237 254 238 If `tracd` is the only web server used for the project, 239 it can also be used to distribute static content 255 If `tracd` is the only web server used for the project, 256 it can also be used to distribute static content 240 257 (tarballs, Doxygen documentation, etc.) 241 258 … … 244 261 245 262 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 246 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 263 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 247 264 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). 248 265 … … 284 301 implements(IAuthenticator) 285 302 286 obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false', 287 """Whether the 'Remote-User:' HTTP header is to be trusted for user logins 288 (''since ??.??').""") 303 obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false', 304 """Whether the 'Remote-User:' HTTP header is to be trusted for user logins 305 (''since ??.??').""") 289 306 290 307 def authenticate(self, req): 291 if self.obey_remote_user_header and req.get_header('Remote-User'): 292 return req.get_header('Remote-User') 308 if self.obey_remote_user_header and req.get_header('Remote-User'): 309 return req.get_header('Remote-User') 293 310 return None 294 311
