Edgewall Software

Changes between Initial Version and Version 1 of 0.11/TracStandalone


Ignore:
Timestamp:
Apr 10, 2010, 7:02:45 PM (12 years ago)
Author:
Christian Boos
Comment:

archiving wiki:/TracStandalone@79

Legend:

Unmodified
Added
Removed
Modified
  • 0.11/TracStandalone

    v1 v1  
     1= Tracd =
     2
     3Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script].
     4
     5== Pros ==
     6
     7 * Fewer dependencies: You don't need to install apache or any other web-server.
     8 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
     9 * 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).
     10  * Options for tracd: `-r, --auto-reload`
     11
     12== Cons ==
     13
     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 [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.
     17
     18== Usage examples ==
     19
     20A single project on port 8080. (http://localhost:8080/)
     21{{{
     22 $ tracd -p 8080 /path/to/project
     23}}}
     24Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
     25{{{
     26 $ tracd --hostname=localhost -p 8080 /path/to/project
     27}}}
     28With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
     29{{{
     30 $ tracd -p 8080 /path/to/project1 /path/to/project2
     31}}}
     32
     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.
     35
     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:
     37{{{
     38 $ tracd -p 8080 -e /path/to
     39}}}
     40
     41To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
     42
     43== Installing as a Windows Service ==
     44
     45=== Option 1 ===
     46To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
     47{{{
     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\tracd-script.py\" <your tracd parameters>"
     50 net start tracd
     51}}}
     52
     53'''DO NOT''' use {{{tracd.exe}}}.  Instead register {{{python.exe}}} directly with {{{tracd-script.py}}} 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
     55If you want tracd to start automatically when you boot Windows, do:
     56{{{
     57 sc config tracd start= auto
     58}}}
     59
     60The spacing here is important.
     61
     62For Windows 7 User, srvany.exe may not be an option, so you can use [http://www.google.com/search?q=winserv.exe WINSERV] utility and run:
     63{{{
     64"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd-script.py <your tracd parameters>"
     65
     66net start tracd
     67}}}
     68
     69=== Option 2 ===
     70
     71Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service.
     72
     73== Using Authentication ==
     74`tracd` provides support for both Basic and Digest authentication. The default is to use Digest.
     75
     76  ''Support for Basic authentication was added in version 0.9.''
     77
     78The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth):
     79
     80{{{
     81 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
     82}}}
     83
     84where:
     85
     86 * '''base_project_dir''': the base directory of the project specified as follows:
     87   * when serving multiple projects: ''relative'' to the `project_bath`
     88   * when serving only a single project (`-s`): the name of the project directory
     89 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
     90 * '''password_file_path''': path to the password file
     91 * '''realm''': the realm name (can be anything)
     92 * '''project_path''': path of the project
     93
     94Examples:
     95
     96{{{
     97 $ tracd -p 8080 \
     98   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
     99}}}
     100
     101Of course, the password file can be be shared so that it is used for more than one project:
     102{{{
     103 $ tracd -p 8080 \
     104   --auth="project1,/path/to/passwordfile,mycompany.com" \
     105   --auth="project2,/path/to/passwordfile,mycompany.com" \
     106   /path/to/project1 /path/to/project2
     107}}}
     108
     109Another way to share the password file is to specify "*" for the project name:
     110{{{
     111 $ tracd -p 8080 \
     112   --auth="*,/path/to/users.htdigest,mycompany.com" \
     113   /path/to/project1 /path/to/project2
     114}}}
     115
     116=== Using a htpasswd password file ===
     117This section describes how to use `tracd` with Apache .htpasswd files.
     118
     119To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     120
     121{{{
     122 $ sudo htpasswd -c /path/to/env/.htpasswd username
     123}}}
     124then for additional users:
     125{{{
     126 $ sudo htpasswd /path/to/env/.htpasswd username2
     127}}}
     128
     129Then to start `tracd` run something like this:
     130
     131{{{
     132 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     133}}}
     134
     135For example:
     136
     137{{{
     138 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
     139}}}
     140
     141''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
     142
     143=== Using a htdigest password file ===
     144
     145If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [http://httpd.apache.org/docs/2.0/programs/htdigest.html 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.
     146
     147Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.
     148
     149=== Generating Passwords Without Apache ===
     150
     151If you don't have Apache available, you can use this simple Python script to generate your passwords:
     152
     153{{{
     154#!python
     155from optparse import OptionParser
     156# The md5 module is deprecated in Python 2.5
     157try:
     158    from hashlib import md5
     159except ImportError:
     160    from md5 import md5
     161realm = 'trac'
     162
     163# build the options
     164usage = "usage: %prog [options]"
     165parser = OptionParser(usage=usage)
     166parser.add_option("-u", "--username",action="store", dest="username", type = "string",
     167                  help="the username for whom to generate a password")
     168parser.add_option("-p", "--password",action="store", dest="password", type = "string",
     169                  help="the password to use")
     170parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     171                  help="the realm in which to create the digest")
     172(options, args) = parser.parse_args()
     173
     174# check options
     175if (options.username is None) or (options.password is None):
     176   parser.error("You must supply both the username and password")
     177if (options.realm is not None):
     178   realm = options.realm
     179   
     180# Generate the string to enter into the htdigest file
     181kd = lambda x: md5(':'.join(x)).hexdigest()
     182print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
     183}}}
     184
     185Note: If you use the above script you must use the --auth option to tracd, not --basic-auth, and you must set the realm in the --auth value to 'trac' (without the quotes). Example usage (assuming you saved the script as trac-digest.py):
     186
     187{{{
     188 $ python trac-digest.py -u username -p password >> c:\digest.txt
     189 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     190}}}
     191
     192Note: If you would like to use --basic-auth you need to use htpasswd tool from apache server to generate .htpasswd file. The remaining part is similar but make sure to use empty realm (i.e. coma after path). When using on Windows make sure to use -m option for it (did not tested it on *nix, so not sure if that is the case there).  If you do not have Apache, [trac:source:/tags/trac-0.11b2/contrib/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
     193
     194It is possible to use md5sum utility to generate digest-password file using such method:
     195{{{
     196 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
     197}}}
     198and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
     199
     200== Tips ==
     201
     202=== Serving static content ===
     203
     204If `tracd` is the only webserver used for the project,
     205it can also be used to distribute static content
     206(tarballs, Doxygen documentation, etc.)
     207
     208This static content should be put in the `$TRAC_ENV/htdocs` folder,
     209and is accessed by URLs like `<project_URL>/chrome/site/...`.
     210
     211Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
     212the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`,
     213which in turn can be written using the relative link syntax
     214in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]`
     215
     216Since 0.10, Trac supports a new `htdocs:` TracLinks
     217syntax for the above. With this, the example link above can be written simply
     218`htdocs:software-0.1.tar.gz`.
     219
     220=== Using apache rewrite rules ===
     221In some situations when you choose to use tracd behind apache, 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.
     222
     223=== Serving a different base path than / ===
     224Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     225{{{
     226 $ tracd --base-path=/some/path
     227}}}
     228
     229----
     230See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]