Edgewall Software

Changes between Version 3 and Version 4 of 1.5/TracStandalone


Ignore:
Timestamp:
Mar 7, 2022, 8:25:06 AM (2 years ago)
Author:
Jun Omae
Comment:

Merged TracStandalone@125

Legend:

Unmodified
Added
Removed
Modified

  • 1.5/TracStandalone

    v3 v4  
    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:TracModPython mod_python] 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
    … …  
    2929}}}
    3030
    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
    32 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.
    3332
    3433An 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:
    … …  
    3938There 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].
    4039
    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.
     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
     45
    4646To install as a Windows service, get the [https://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    4747{{{#!cmd
    … …  
    5252
    5353{{{#!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`.
     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`.
    5555}}}
    5656
    … …  
    7171||!AppParameters ||scripts\tracd.exe -p 8080 ... ||
    7272
    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.)
     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.
    7575}}}
    7676
    … …  
    9595== Using Authentication
    9696
    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)
     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.
    9898
    9999{{{#!div style="border: 1pt dotted; margin: 1em"
    … …  
    141141
    142142=== Basic Authorization: Using a htpasswd password file
     143
    143144This section describes how to use `tracd` with Apache .htpasswd files.
    144145
    145   Note: On Windows It is necessary to install the [https://pypi.python.org/pypi/passlib passlib]
    146   package in order to decode some htpasswd formats. Only `SHA-1` passwords (since Trac 1.0)
    147   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.
    148147
    149148To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
    … …  
    165164 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
    166165}}}
    167 ''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).
    168168
    169169=== Digest authentication: Using a htdigest password file
    … …  
    189189
    190190==== Using `md5sum`
     191
    191192It is possible to use `md5sum` utility to generate digest-password file:
    192193{{{#!sh
    … …  
    251252=== Serving static content
    252253
    253 If `tracd` is the only web server used for the project,
    254 it can also be used to distribute static content
    255 (tarballs, Doxygen documentation, etc.)
    256 
    257 This static content should be put in the `$TRAC_ENV/htdocs` folder,
    258 and is accessed by URLs like `<project_URL>/chrome/site/...`.
    259 
    260 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
    261 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
    262 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).
    263259
    264260=== Using tracd behind a proxy
    … …  
    273269
    274270=== Authentication for tracd behind a proxy
    275 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].
    276273
    277274Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
    … …  
    323320}}}
    324321
    325 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`.
    326323
    327324Global config (e.g. `/srv/trac/conf/trac.ini`):
    … …  
    342339
    343340=== Serving a different base path than /
    344 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:
    345343{{{#!sh
    346344 $ tracd --base-path=/some/path