Changes between Version 4 and Version 5 of TracStandalone


Ignore:
Timestamp:
Sep 24, 2024, 8:58:40 AM (6 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracStandalone

    v4 v5  
    66== Pros
    77
    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: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
    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).
     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.
    1111
    1212== Cons
    1313
    1414 * 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 [trac:wiki:STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
    1715
    1816== Usage examples
    … …  
    3129}}}
    3230
    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.
     31You 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.
    3532
    3633An 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:
    … …  
    3936}}}
    4037
    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.
     38There 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
     40To exit the server on Windows, be sure to use `CTRL-BREAK`. Using `CTRL-C` will leave a Python process running in the background.
    4241
    4342== Installing as a Windows Service
    4443
    4544=== Option 1
    46 To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
     45
     46To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    4747{{{#!cmd
    4848 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>"
    5050 net start tracd
    5151}}}
    5252
    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}}}
    5456
    5557If you want tracd to start automatically when you boot Windows, do:
    … …  
    6567
    6668Three (string) parameters are provided:
    67 ||!AppDirectory ||C:\Python26\ ||
     69||!AppDirectory ||C:\Python27\ ||
    6870||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:
     71||!AppParameters ||scripts\tracd.exe -p 8080 ... ||
     72
     73Note 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.
     74This 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
     77For 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:
    7678{{{#!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>"
     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>"
    7880net start tracd
    7981}}}
    … …  
    8183=== Option 2
    8284
    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.
     85Use [https://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [https://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
    8486
    8587=== Option 3
    … …  
    9395== Using Authentication
    9496
    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)
     97Tracd 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.
    9698
    9799{{{#!div style="border: 1pt dotted; margin: 1em"
    … …  
    139141
    140142=== Basic Authorization: Using a htpasswd password file
     143
    141144This section describes how to use `tracd` with Apache .htpasswd files.
    142145
    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.
     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.
    146147
    147148To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    … …  
    163164 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
    164165}}}
    165 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     166
     167'''Note:''' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    166168
    167169=== Digest authentication: Using a htdigest password file
    168170
    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.
     171If 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.
    170172
    171173Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
    … …  
    175177Basic 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.
    176178
    177 Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
     179Trac also provides `htpasswd` and `htdigest` scripts in [https://trac.edgewall.org/browser/trunk/contrib contrib] (also available in the tar or zip archive):
    178180{{{#!sh
    179181$ ./contrib/htpasswd.py -cb htpasswd user1 user1
    … …  
    187189
    188190==== Using `md5sum`
     191
    189192It is possible to use `md5sum` utility to generate digest-password file:
    190193{{{#!sh
    … …  
    198201== Reference
    199202
    200 Here's the online help, as a reminder (`tracd --help`):
     203Here's the online help, as a reminder (`tracd -h` or `tracd --help`):
    201204{{{
    202 Usage: tracd [options] [projenv] ...
    203 
    204 Options:
     205usage: 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
     213positional arguments:
     214  envs                  path of the project environment(s)
     215
     216options:
     217  -h, --help            show this help message and exit
    205218  --version             show program's version number and exit
    206   -h, --help            show this help message and exit
    207   -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
    208223                        [projectdir],[htdigest_file],[realm]
    209   --basic-auth=BASICAUTH
     224  --basic-auth BASICAUTH
    210225                        [projectdir],[htpasswd_file],[realm]
    211   -p PORT, --port=PORT  the port number to bind to
    212   -b HOSTNAME, --hostname=HOSTNAME
     226  -p PORT, --port PORT  the port number to bind to
     227  -b HOSTNAME, --hostname HOSTNAME
    213228                        the host name or IP address to bind to
    214   --protocol=PROTOCOL   http|scgi|ajp|fcgi
    215   -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
    216   --http10              use HTTP/1.0 protocol version instead of HTTP/1.1
    217   --http11              use HTTP/1.1 protocol version (default)
    218   -e PARENTDIR, --env-parent-dir=PARENTDIR
    219                         parent directory of the project environments
    220   --base-path=BASE_PATH
     229  --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
    221236                        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)
    222239  -r, --auto-reload     restart automatically when sources are modified
    223   -s, --single-env      only serve a single project without the project list
    224240  -d, --daemonize       run in the background as a daemon
    225   --pidfile=PIDFILE     when daemonizing, file to which to write pid
    226   --umask=MASK          when daemonizing, file mode creation mask to use, in
    227                         octal notation (default 022)
    228   --group=GROUP         the group to run as
    229   --user=USER           the user to run as
     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
    230246}}}
    231247
    … …  
    236252=== Serving static content
    237253
    238 If `tracd` is the only web server used for the project,
    239 it can also be used to distribute static content
    240 (tarballs, Doxygen documentation, etc.)
    241 
    242 This static content should be put in the `$TRAC_ENV/htdocs` folder,
    243 and is accessed by URLs like `<project_URL>/chrome/site/...`.
    244 
    245 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`,
    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).
     254If `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
     256This static content should be put in the `$TRAC_ENV/htdocs` folder, and is accessed by URLs like `<project_URL>/chrome/site/...`.
     257
     258Example: 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).
    248259
    249260=== Using tracd behind a proxy
    … …  
    258269
    259270=== Authentication for tracd behind a proxy
    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].
     271
     272It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. See also [trac:#9206].
    261273
    262274Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
    … …  
    284296    implements(IAuthenticator)
    285297
    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 ??.??').""") 
     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 ??.??').""")
    289301
    290302    def authenticate(self, req):
    291         if self.obey_remote_user_header and req.get_header('Remote-User'): 
    292             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')
    293305        return None
    294306
    … …  
    308320}}}
    309321
    310 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.
     322Note 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`.
    311323
    312324Global config (e.g. `/srv/trac/conf/trac.ini`):
    … …  
    327339
    328340=== Serving a different base path than /
    329 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     341
     342Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is:
    330343{{{#!sh
    331344 $ tracd --base-path=/some/path