-
Notifications
You must be signed in to change notification settings - Fork 145
TracStandalone
- Note: this page documents the version 1.0 of Trac, see 0.12/TracStandalone if you need the previous version **
Tracd is a lightweight standalone Trac web server. 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.
* 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).
* 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 [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
A single project on port 8080. (http://localhost:8080/)
Stricly speaking this will make your Trac accessible to everybody from your network rather than localhost only. To truly limit it use --hostname option.
With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/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.
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 -- using will leave a Python process running in the background.
To install as a Windows service, get the SRVANY utility and run:
DO NOT use . Instead register directly with as a parameter. If you use , it will spawn the python process without SRVANY's knowledge. This python process will survive a .
If you want tracd to start automatically when you boot Windows, do:
The spacing here is important.
For Windows 7 User, srvany.exe may not be an option, so you can use WINSERV utility and run: \path\to\python\scripts\tracd-script.py <your>"
net start tracd }}}
Use <a href="http://trac-hacks.org/wiki/WindowsServiceScript" target="_blank">WindowsServiceScript</a>, available at <a href="http://trac-hacks.org/" target="_blank">Trac Hacks</a>. Installs, removes, starts, stops, etc. your Trac service.
also cygwin's cygrunsrv.exe can be used:
Tracd provides support for both Basic and Digest authentication. Digest is considered more secure. The examples below use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the command line.
The general format for using authentication is:
where:
* '''base_project_dir''': the base directory of the project specified as follows: * when serving multiple projects: ''relative'' to the `project_path` * when serving only a single project (`-s`): the name of the project directory Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. * '''password_file_path''': path to the password file * '''realm''': the realm name (can be anything) * '''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.
Examples:
Of course, the password file can be be shared so that it is used for more than one project:
Another way to share the password file is to specify "*" for the project name:
This section describes how to use `tracd` with Apache .htpasswd files.
Note: It is necessary (at least with Python 2.6) to install the fcrypt package in order to decode some htpasswd formats. Trac source code attempt an `import crypt` first, but there is no such package for Python 2.6. Only `SHA-1` passwords (since Trac 1.0) work without this module.
To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache] for a method to create these files without using Apache):
then for additional users:
Then to start `tracd` run something like this:
For example:
Note: You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
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 <a href="http://httpd.apache.org/docs/2.0/programs/htdigest.html" target="_blank">this page</a> 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></projectname></conf></your>folder along with the [TracIni] file.
Note that you can start tracd without the `--auth` argument, but if you click on the Login link you will get an error.
Basic Authorization can be accomplished via this 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.
You can use this simple Python script to generate a digest password file:
Note: If you use the above script you must set the realm in the `--auth` argument to `trac`. Example usage (assuming you saved the script as trac-digest.py):
==== Using `md5sum` It is possible to use `md5sum` utility to generate digest-password file:
Here's the online help, as a reminder (`tracd --help`):
Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
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></project_name></chrome/site/software-0.1.tar.gz`,></project_url> which in turn can be written as `htdocs:software-0.1.tar.gz` (TracLinks syntax) or `/<project_name></project_name>/chrome/site/software-0.1.tar.gz` (relative link syntax).
''Support for `htdocs:` TracLinks syntax was added in version 0.10''
=== Using tracd behind a proxy
In some situations when you choose to use tracd behind Apache or another web server.
In this situation, you might experience issues with redirects, like being redirected to URLs with the wrong host or protocol. In this case (and only in this case), setting the `[trac] use_base_url_for_redirect` to `true` can help, as this will force Trac to use the value of `[trac] base_url` for doing the redirects.
If you're using the AJP protocol to connect with `tracd` (which is possible if you have flup installed), then you might experience problems with double quoting. Consider adding the `--unquote` parameter.
See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
=== Authentication for tracd behind a proxy It is convenient to provide central external authentication to your tracd instances, instead of using . There is some discussion about this in #9206.
Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
First we bring tracd into Apache's location namespace.
Then we need a single file plugin to recognize HTTP_REMOTE_USER header as valid authentication source. HTTP headers like HTTP_FOO_BAR will get converted to Foo-Bar during processing. Name it something like remote-user-auth.py and drop it into proxified/plugins directory:
Add this new parameter to your TracIni:
Run tracd:
Note that if you want to install this plugin for all projects, you have to put it in your [TracPlugins#Plugindiscovery] and enable it in your global trac.ini.
Global config (e.g. `/srv/trac/conf/trac.ini`):
Environment config (e.g. `/srv/trac/envs/myenv`):
Tracd supports serving projects with different base urls than /<project></project>. The parameter name to change this is
See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice]