Changes between Initial Version and Version 1 of TracStandalone

Nov 26, 2018, 5:35:04 PM (4 years ago)



  • TracStandalone

    v1 v1  
     1= Tracd
     3Tracd is a lightweight standalone Trac web server.
     4It 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.
     6== Pros
     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).
     12== Cons
     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: [ 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.
     18== Usage examples
     20A single project on port 8080. (http://localhost:8080/)
     22 $ tracd -p 8080 /path/to/project
     24Strictly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use the `--hostname` option.
     26 $ tracd --hostname=localhost -p 8080 /path/to/project
     28With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
     30 $ tracd -p 8080 /path/to/project1 /path/to/project2
     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.
     36An 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:
     38 $ tracd -p 8080 -e /path/to
     41To exit the server on Windows, be sure to use `CTRL-BREAK` -- using `CTRL-C` will leave a Python process running in the background.
     43== Installing as a Windows Service
     45=== Option 1
     46To install as a Windows service, get the [ SRVANY] utility and run:
     48 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\\" <your tracd parameters>"
     50 net start tracd
     53'''DO NOT''' use {{{tracd.exe}}}.  Instead register {{{python.exe}}} directly with {{{}}} 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}}}.
     55If you want tracd to start automatically when you boot Windows, do:
     57 sc config tracd start= auto
     60The spacing here is important.
     63Once the service is installed, it might be simpler to run the Registry Editor rather than use the `reg add` command documented above.  Navigate to:[[BR]]
     66Three (string) parameters are provided:
     67||!AppDirectory ||C:\Python26\ ||
     68||Application ||python.exe ||
     69||!AppParameters ||scripts\ -p 8080 ... ||
     71Note 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.)
     75For Windows 7 User, srvany.exe may not be an option, so you can use [ WINSERV] utility and run:
     77"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\ <your tracd parameters>"
     78net start tracd
     81=== Option 2
     83Use [ WindowsServiceScript], available at [ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     85=== Option 3
     87also cygwin's cygrunsrv.exe can be used:
     89$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
     90$ net start tracd
     93== Using Authentication
     95Tracd 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{{{#!div style="border: 1pt dotted; margin: 1em"
     98**Attention:** Make sure you place the generated password files on a filesystem which supports sub-second timestamps, as Trac will monitor their modified time and changes happening on a filesystem with too coarse-grained timestamp resolution (like `ext2` or `ext3` on Linux, or HFS+ on OSX).
     101Tracd 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.
     103The general format for using authentication is:
     105 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
     108 * '''base_project_dir''': the base directory of the project specified as follows:
     109   * when serving multiple projects: ''relative'' to the `project_path`
     110   * when serving only a single project (`-s`): the name of the project directory
     111 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
     112 * '''password_file_path''': path to the password file
     113 * '''realm''': the realm name (can be anything)
     114 * '''project_path''': path of the project
     116 * **`--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.
     121 $ tracd -p 8080 \
     122   --auth="project1,/path/to/passwordfile," /path/to/project1
     125Of course, the password file can be be shared so that it is used for more than one project:
     127 $ tracd -p 8080 \
     128   --auth="project1,/path/to/passwordfile," \
     129   --auth="project2,/path/to/passwordfile," \
     130   /path/to/project1 /path/to/project2
     133Another way to share the password file is to specify "*" for the project name:
     135 $ tracd -p 8080 \
     136   --auth="*,/path/to/users.htdigest," \
     137   /path/to/project1 /path/to/project2
     140=== Basic Authorization: Using a htpasswd password file
     141This section describes how to use `tracd` with Apache .htpasswd files.
     143  Note: On Windows It is necessary to install the [ passlib]
     144  package in order to decode some htpasswd formats. Only `SHA-1` passwords (since Trac 1.0)
     145  work without this module.
     147To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     149 $ sudo htpasswd -c /path/to/env/.htpasswd username
     151then for additional users:
     153 $ sudo htpasswd /path/to/env/.htpasswd username2
     156Then to start `tracd` run something like this:
     158 $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project
     161For example:
     163 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
     165''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     167=== Digest authentication: Using a htdigest password file
     169If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [ 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.
     171Note that you can start tracd without the `--auth` argument, but if you click on the ''Login'' link you will get an error.
     173=== Generating Passwords Without Apache
     175Basic 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.
     177Trac also provides `htpasswd` and `htdigest` scripts in `contrib`:
     179$ ./contrib/ -cb htpasswd user1 user1
     180$ ./contrib/ -b htpasswd user2 user2
     184$ ./contrib/ -cb htdigest trac user1 user1
     185$ ./contrib/ -b htdigest trac user2 user2
     188==== Using `md5sum`
     189It is possible to use `md5sum` utility to generate digest-password file:
     195echo ${user}:${realm}:$(printf "${user}:${realm}:${password}" | md5sum - | sed -e 's/\s\+-//') > ${path_to_file}
     198== Reference
     200Here's the online help, as a reminder (`tracd --help`):
     202Usage: tracd [options] [projenv] ...
     205  --version             show program's version number and exit
     206  -h, --help            show this help message and exit
     207  -a DIGESTAUTH, --auth=DIGESTAUTH
     208                        [projectdir],[htdigest_file],[realm]
     209  --basic-auth=BASICAUTH
     210                        [projectdir],[htpasswd_file],[realm]
     211  -p PORT, --port=PORT  the port number to bind to
     212  -b HOSTNAME, --hostname=HOSTNAME
     213                        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
     221                        the initial portion of the request URL's "path"
     222  -r, --auto-reload     restart automatically when sources are modified
     223  -s, --single-env      only serve a single project without the project list
     224  -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
     232Use the -d option so that tracd doesn't hang if you close the terminal window where tracd was started.
     234== Tips
     236=== Serving static content
     238If `tracd` is the only web server used for the project,
     239it can also be used to distribute static content
     240(tarballs, Doxygen documentation, etc.)
     242This static content should be put in the `$TRAC_ENV/htdocs` folder,
     243and is accessed by URLs like `<project_URL>/chrome/site/...`.
     245Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
     246the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     247which 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).
     249=== Using tracd behind a proxy
     251In some situations when you choose to use tracd behind Apache or another web server.
     253In 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.
     255If 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.
     257See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
     259=== Authentication for tracd behind a proxy
     260It 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].
     262Below is example configuration based on Apache 2.2, mod_proxy, mod_authnz_ldap.
     264First we bring tracd into Apache's location namespace.
     267<Location /project/proxified>
     268        Require ldap-group cn=somegroup, ou=Groups,
     269        Require ldap-user somespecificusertoo
     270        ProxyPass http://localhost:8101/project/proxified/
     271        # Turns out we don't really need complicated RewriteRules here at all
     272        RequestHeader set REMOTE_USER %{REMOTE_USER}s
     276Then 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 '''''' and drop it into '''proxified/plugins''' directory:
     278from trac.core import *
     279from trac.config import BoolOption
     280from trac.web.api import IAuthenticator
     282class MyRemoteUserAuthenticator(Component):
     284    implements(IAuthenticator)
     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 ??.??').""")
     290    def authenticate(self, req):
     291        if self.obey_remote_user_header and req.get_header('Remote-User'):
     292            return req.get_header('Remote-User')
     293        return None
     297Add this new parameter to your TracIni:
     301obey_remote_user_header = true
     305Run tracd:
     307tracd -p 8101 -s proxified --base-path=/project/proxified
     310Note 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.
     312Global config (e.g. `/srv/trac/conf/trac.ini`):
     315remote-user-auth.* = enabled
     317plugins_dir = /srv/trac/plugins
     319obey_remote_user_header = true
     322Environment config (e.g. `/srv/trac/envs/myenv`):
     325file = /srv/trac/conf/trac.ini
     328=== Serving a different base path than /
     329Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     331 $ tracd --base-path=/some/path
     335See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]