Changes between Version 6 and Version 7 of TracStandalone


Ignore:
Timestamp:
Sep 8, 2024, 12:14:12 PM (12 days ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracStandalone

    v6 v7  
    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: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.
     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).
    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.
    1517
    1618== Usage examples
    … …  
    2931}}}
    3032
    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.
     33You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the
     34different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project.
    3235
    3336An 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:
    … …  
    3841There 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].
    3942
    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.
     43To exit the server on Windows, be sure to use `CTRL-BREAK` -- using `CTRL-C` will leave a Python process running in the background.
    4144
    4245== Installing as a Windows Service
    4346
    4447=== Option 1
    45 
    4648To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    4749{{{#!cmd
    … …  
    5254
    5355{{{#!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`.
     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`.
    5557}}}
    5658
    … …  
    7173||!AppParameters ||scripts\tracd.exe -p 8080 ... ||
    7274
    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.
     75Note 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.
     76(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.)
    7577}}}
    7678
    … …  
    9597== Using Authentication
    9698
    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.
     99Tracd 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)
    98100
    99101{{{#!div style="border: 1pt dotted; margin: 1em"
    … …  
    141143
    142144=== Basic Authorization: Using a htpasswd password file
    143 
    144145This section describes how to use `tracd` with Apache .htpasswd files.
    145146
    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.
     147  Note: On Windows It is necessary to install the [https://pypi.python.org/pypi/passlib passlib]
     148  package in order to decode some htpasswd formats. Only `SHA-1` passwords (since Trac 1.0)
     149  work without this module.
    147150
    148151To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    … …  
    164167 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
    165168}}}
    166 
    167 '''Note:''' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     169''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    168170
    169171=== Digest authentication: Using a htdigest password file
    … …  
    177179Basic 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.
    178180
    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):
     181Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
    180182{{{#!sh
    181183$ ./contrib/htpasswd.py -cb htpasswd user1 user1
    … …  
    189191
    190192==== Using `md5sum`
    191 
    192193It is possible to use `md5sum` utility to generate digest-password file:
    193194{{{#!sh
    … …  
    214215  envs                  path of the project environment(s)
    215216
    216 options:
     217optional arguments:
    217218  -h, --help            show this help message and exit
    218219  --version             show program's version number and exit
    … …  
    252253=== Serving static content
    253254
    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).
     255If `tracd` is the only web server used for the project,
     256it can also be used to distribute static content
     257(tarballs, Doxygen documentation, etc.)
     258
     259This static content should be put in the `$TRAC_ENV/htdocs` folder,
     260and is accessed by URLs like `<project_URL>/chrome/site/...`.
     261
     262Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
     263the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     264which 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).
    259265
    260266=== Using tracd behind a proxy
    … …  
    269275
    270276=== Authentication for tracd behind a proxy
    271 
    272 It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. See also [trac:#9206].
     277It 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].
    273278
    274279Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
    … …  
    320325}}}
    321326
    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`.
     327Note 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.
    323328
    324329Global config (e.g. `/srv/trac/conf/trac.ini`):
    … …  
    339344
    340345=== 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:
     346Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
    343347{{{#!sh
    344348 $ tracd --base-path=/some/path