Changes between Version 5 and Version 6 of TracStandalone
- Timestamp:
- 09/05/24 07:04:00 (4 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v5 v6 6 6 == Pros 7 7 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:TracMod Python 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 default10 * 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. 11 11 12 12 == Cons 13 13 14 14 * 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.17 15 18 16 == Usage examples … … 31 29 }}} 32 30 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. 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. 35 32 36 33 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: … … 41 38 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 39 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.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. 44 41 45 42 == Installing as a Windows Service 46 43 47 44 === Option 1 45 48 46 To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run: 49 47 {{{#!cmd … … 54 52 55 53 {{{#!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`.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`. 57 55 }}} 58 56 … … 73 71 ||!AppParameters ||scripts\tracd.exe -p 8080 ... || 74 72 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. 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.) 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. 77 75 }}} 78 76 … … 97 95 == Using Authentication 98 96 99 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)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. 100 98 101 99 {{{#!div style="border: 1pt dotted; margin: 1em" … … 143 141 144 142 === Basic Authorization: Using a htpasswd password file 143 145 144 This section describes how to use `tracd` with Apache .htpasswd files. 146 145 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. 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. 150 147 151 148 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): … … 167 164 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project 168 165 }}} 169 ''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). 170 168 171 169 === Digest authentication: Using a htdigest password file … … 179 177 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. 180 178 181 Trac also provides `htpasswd` and `htdigest` scripts in `contrib`: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): 182 180 {{{#!sh 183 181 $ ./contrib/htpasswd.py -cb htpasswd user1 user1 … … 191 189 192 190 ==== Using `md5sum` 191 193 192 It is possible to use `md5sum` utility to generate digest-password file: 194 193 {{{#!sh … … 208 207 [--protocol {http,https,scgi,ajp,fcgi}] [--certfile CERTFILE] 209 208 [--keyfile KEYFILE] [-q] [--base-path BASE_PATH] 210 [--http10 | --http11] [-r | -d] [--pidfile PIDFILE] 211 [-- umask MASK] [--group GROUP] [--user USER]212 [envs [envs ...]]209 [--http10 | --http11] [-r | -d] [--pidfile PIDFILE] [--umask MASK] 210 [--group GROUP] [--user USER] 211 [envs ...] 213 212 214 213 positional arguments: 215 214 envs path of the project environment(s) 216 215 217 option al arguments:216 options: 218 217 -h, --help show this help message and exit 219 218 --version show program's version number and exit … … 253 252 === Serving static content 254 253 255 If `tracd` is the only web server used for the project, 256 it can also be used to distribute static content 257 (tarballs, Doxygen documentation, etc.) 258 259 This static content should be put in the `$TRAC_ENV/htdocs` folder, 260 and is accessed by URLs like `<project_URL>/chrome/site/...`. 261 262 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 263 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 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). 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). 265 259 266 260 === Using tracd behind a proxy … … 275 269 276 270 === Authentication for tracd behind a proxy 277 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 272 It is convenient to provide central external authentication to your tracd instances, instead of using `--basic-auth`. See also [trac:#9206]. 278 273 279 274 Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap. … … 325 320 }}} 326 321 327 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.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`. 328 323 329 324 Global config (e.g. `/srv/trac/conf/trac.ini`): … … 344 339 345 340 === Serving a different base path than / 346 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 341 342 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is: 347 343 {{{#!sh 348 344 $ tracd --base-path=/some/path