Changes between Version 7 and Version 8 of TracStandalone

Timestamp:

Apr 16, 2021, 8:25:01 AM (4 years ago)

Author:

trac

Comment:

--

TracStandalone

@@ -38 +38 @@
  $ tracd -p 8080 -e /path/to
 }}}
+
+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].
 
 To exit the server on Windows, be sure to use `CTRL-BREAK` -- using `CTRL-C` will leave a Python process running in the background.
@@ -47 +49 @@
 {{{#!cmd
  C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
- 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>"
+ 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>"
  net start tracd
 }}}
 
-'''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}}}.
+{{{#!div style="border: 1pt dotted; margin: 1em;"
+**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`.
+}}}
 
 If you want tracd to start automatically when you boot Windows, do:
@@ -65 +69 @@
 
 Three (string) parameters are provided:
-||!AppDirectory ||C:\Python26\ ||
+||!AppDirectory ||C:\Python27\ ||
 ||Application ||python.exe ||
-||!AppParameters ||scripts\tracd-script.py -p 8080 ... ||
+||!AppParameters ||scripts\tracd.exe -p 8080 ... ||
 
 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.
@@ -75 +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:
 {{{#!cmd
-"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>"
+"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>"
 net start tracd
 }}}
@@ -198 +202 @@
 == Reference
 
-Here's the online help, as a reminder (`tracd --help`):
+Here's the online help, as a reminder (`tracd -h` or `tracd --help`):
 {{{
-Usage: tracd [options] [projenv] ...
-
-Options:
+usage: tracd [-h] [--version] [-e PARENTDIR | -s]
+             [-a DIGESTAUTH | --basic-auth BASICAUTH] [-p PORT] [-b HOSTNAME]
+             [--protocol {http,https,scgi,ajp,fcgi}] [--certfile CERTFILE]
+             [--keyfile KEYFILE] [-q] [--base-path BASE_PATH] [--http10 | --http11]
+             [-r | -d] [--pidfile PIDFILE] [--umask MASK] [--group GROUP] [--user USER]
+             [envs [envs ...]]
+
+positional arguments:
+  envs                  path of the project environment(s)
+
+optional arguments:
+  -h, --help            show this help message and exit
   --version             show program's version number and exit
-  -h, --help            show this help message and exit
-  -a DIGESTAUTH, --auth=DIGESTAUTH
+  -e PARENTDIR, --env-parent-dir PARENTDIR
+                        parent directory of the project environments
+  -s, --single-env      only serve a single project without the project list
+  -a DIGESTAUTH, --auth DIGESTAUTH
                         [projectdir],[htdigest_file],[realm]
-  --basic-auth=BASICAUTH
+  --basic-auth BASICAUTH
                         [projectdir],[htpasswd_file],[realm]
-  -p PORT, --port=PORT  the port number to bind to
-  -b HOSTNAME, --hostname=HOSTNAME
+  -p PORT, --port PORT  the port number to bind to
+  -b HOSTNAME, --hostname HOSTNAME
                         the host name or IP address to bind to
-  --protocol=PROTOCOL   http|scgi|ajp|fcgi
-  -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
-  --http10              use HTTP/1.0 protocol version instead of HTTP/1.1
-  --http11              use HTTP/1.1 protocol version (default)
-  -e PARENTDIR, --env-parent-dir=PARENTDIR
-                        parent directory of the project environments
-  --base-path=BASE_PATH
+  --protocol {http,https,scgi,ajp,fcgi}
+                        the server protocol (default: http)
+  --certfile CERTFILE   PEM certificate file for HTTPS
+  --keyfile KEYFILE     PEM key file for HTTPS
+  -q, --unquote         unquote PATH_INFO (may be needed when using the ajp protocol)
+  --base-path BASE_PATH
                         the initial portion of the request URL's "path"
+  --http10              use HTTP/1.0 protocol instead of HTTP/1.1
+  --http11              use HTTP/1.1 protocol (default)
   -r, --auto-reload     restart automatically when sources are modified
-  -s, --single-env      only serve a single project without the project list
   -d, --daemonize       run in the background as a daemon
-  --pidfile=PIDFILE     when daemonizing, file to which to write pid
-  --umask=MASK          when daemonizing, file mode creation mask to use, in
-                        octal notation (default 022)
-  --group=GROUP         the group to run as
-  --user=USER           the user to run as
+  --pidfile PIDFILE     file to write pid when daemonizing
+  --umask MASK          when daemonizing, file mode creation mask to use, in octal
+                        notation (default: 022)
+  --group GROUP         the group to run as
+  --user USER           the user to run as
 }}}
 
@@ -236 +251 @@
 === Serving static content
 
-If `tracd` is the only web server used for the project, 
-it can also be used to distribute static content 
+If `tracd` is the only web server used for the project,
+it can also be used to distribute static content
 (tarballs, Doxygen documentation, etc.)
 
@@ -244 +259 @@
 
 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`, 
+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).
 
@@ -284 +299 @@
     implements(IAuthenticator)
 
-    obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false', 
-               """Whether the 'Remote-User:' HTTP header is to be trusted for user logins 
-                (''since ??.??').""") 
+    obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false',
+               """Whether the 'Remote-User:' HTTP header is to be trusted for user logins
+                (''since ??.??').""")
 
     def authenticate(self, req):
-        if self.obey_remote_user_header and req.get_header('Remote-User'): 
-            return req.get_header('Remote-User') 
+        if self.obey_remote_user_header and req.get_header('Remote-User'):
+            return req.get_header('Remote-User')
         return None