Context Navigation

← Previous Change
Wiki History
Next Change →

Changes between Version 5 and Version 6 of TracStandalone

Timestamp:: Jan 24, 2024, 9:58:09 AM (3 months ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracStandalone

-              v5
+              v6
 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.
+== Pros
+ * Fewer dependencies: You don't need to install apache or any other web-server.
+ * Fast: Should be almost as fast as the [wiki:TracModPython 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 default
+ * 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).
+== Cons
+'''Pros'''
+ * Fewer dependencies: You don't need to install Apache or any other web-server.
+ * 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.
+ * 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.
+'''Cons'''
  * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd.
- * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
-   or [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
 == Usage examples
 A single project on port 8080. (http://localhost:8080/)
+A single project on port 8080, such as `http://localhost:8080/`:
 {{{#!sh
  $ tracd -p 8080 /path/to/project
 }}}
 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.
+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.
 {{{#!sh
  $ tracd --hostname=localhost -p 8080 /path/to/project
 }}}
 With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
+With more than one project, for example `http://localhost:8080/project1/` and `http://localhost:8080/project2/`:
 {{{#!sh
  $ tracd -p 8080 /path/to/project1 /path/to/project2
 }}}
+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.
+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.
 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:
 …
 }}}
+To exit the server on Windows, be sure to use `CTRL-BREAK` -- using `CTRL-C` will leave a Python process running in the background.
+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.
 == Installing as a Windows Service
 === Option 1
+To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
+To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run:
 {{{#!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:
 …
 {{{#!div
 Once the service is installed, it might be simpler to run the Registry Editor rather than use the `reg add` command documented above.  Navigate to:[[BR]]
+Once the service is installed, it might be simpler to run the Registry Editor rather than use the `reg add` command documented above. Navigate to:[[BR]]
 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters`
 Three (string) parameters are provided:
 ||!AppDirectory ||C:\Python26\ ||
+||!AppDirectory ||C:\Python27\ ||
 ||Application ||python.exe ||
 ||!AppParameters ||scripts\tracd-script.py -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.
+(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.)
 }}}
 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:
+||!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.
+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.
+}}}
+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
 }}}
 …
 === Option 2
 Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
+Use [https://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [https://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
 === Option 3
 …
 == Using Authentication
 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)
+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.
 {{{#!div style="border: 1pt dotted; margin: 1em"
 **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).
+**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.
 }}}
 …
  * '''project_path''': path of the project
  * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth.  Although Basic authentication does not require a "realm", the command parser does, so the second comma is required, followed directly by the closing quote for an empty realm name.
+ * **`--auth`** in the above means use Digest authentication, replace `--auth` with `--basic-auth` if you want to use Basic auth. Although Basic authentication does not require a "realm", the command parser does, so the second comma is required, followed directly by the closing quote for an empty realm name.
 Examples:
 …
 === Basic Authorization: Using a htpasswd password file
 This section describes how to use `tracd` with Apache .htpasswd files.
+  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.
+'''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 work without this module (since Trac 1.0).
 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
 …
  $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
 }}}
+''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
+'''Note:''' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
 === Digest authentication: Using a htdigest password file
 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.
+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 will 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.
 Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
 …
 === Generating Passwords Without Apache
 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.
 Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
+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.
+Trac also provides `htpasswd` and `htdigest` scripts in `contrib` (in the Tar package):
 {{{#!sh
 $ ./contrib/htpasswd.py -cb htpasswd user1 user1
 …
 ==== Using `md5sum`
 It is possible to use `md5sum` utility to generate digest-password file:
 {{{#!sh
 …
 == 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
 }}}
 …
 === Serving 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.)
+This static content should be put in the `$TRAC_ENV/htdocs` folder,
+and is accessed by URLs like `<project_URL>/chrome/site/...`.
+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).
+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.
+This static content should be put in the `$TRAC_ENV/htdocs` folder, and is accessed by URLs like `<project_URL>/chrome/site/...`.
+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).
 === Using tracd behind a proxy
 …
 === Authentication for tracd behind a proxy
+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].
+It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. See also [trac:#9206].
 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
 …
     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
 …
 }}}
 Note that if you want to install this plugin for all projects, you have to put it in your [TracPlugins#Plugindiscovery global plugins_dir] and enable it in your global trac.ini.
+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`.
 Global config (e.g. `/srv/trac/conf/trac.ini`):
 …
 === Serving a different base path than /
+Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
+Tracd supports serving projects with different base urls than `/<project>` with the `base_path` parameter:
 {{{#!sh
  $ tracd --base-path=/some/path

Issues

Context Navigation

Changes between Version 5 and Version 6 of TracStandalone

Legend:

TracStandalone

Django Links

Learn More

Get Involved

Get Help

Follow Us

Support Us