Keka
the Mac OS X file archiver
Download Changelog Forum Help Trac Project

Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
03/03/12 13:16:24 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v2  
    6060The spacing here is important.
    6161
    62 {{{#!div
    63 Once 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]]
    64 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters`
    65 
    66 Three (string) parameters are provided:
    67 ||!AppDirectory ||C:\Python26\ ||
    68 ||Application ||python.exe ||
    69 ||!AppParameters ||scripts\tracd-script.py -p 8080 ... ||
    70 
    71 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.
    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.)
    73 }}}
    74 
    7562For 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:
    7663{{{
     
    8673== Using Authentication ==
    8774
    88 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.
    89 
    90 The general format for using authentication is:
     75Using tracd with Apache .htpasswd files:
     76
     77To create a .htpasswd file using htpasswd:
     78
     79{{{
     80 $ htpasswd -c /path/to/env/.htpasswd username
     81}}}
     82then for additional users:
     83{{{
     84 $ htpasswd /path/to/env/.htpasswd username2
     85}}}
     86then for starting the tracd (on windows skip the "=" after --basic-auth):
     87{{{
     88tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
     89}}}
     90
     91 `environmentname` is the directory name of the Trac project folder, as opposed to `/fullpath/environmentname` which is the full path to the Trac project folder. See below for another example.
     92
     93Tracd provides support for both Basic and Digest authentication. The default is to use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the examples below. (You must still specify a dialogic "realm", which can be an empty string by trailing the BASICAUTH with a comma.)
     94
     95  ''Support for Basic authentication was added in version 0.9.''
     96
     97The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth):
     98
    9199{{{
    92100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path
    93101}}}
     102
    94103where:
     104
    95105 * '''base_project_dir''': the base directory of the project specified as follows:
    96106   * when serving multiple projects: ''relative'' to the `project_path`
     
    101111 * '''project_path''': path of the project
    102112
    103  * **`--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.
    104 
    105113Examples:
    106114
     
    125133}}}
    126134
    127 === Basic Authorization: Using a htpasswd password file ===
     135=== Using a htpasswd password file ===
    128136This section describes how to use `tracd` with Apache .htpasswd files.
    129137
    130138To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache):
     139
    131140{{{
    132141 $ sudo htpasswd -c /path/to/env/.htpasswd username
     
    138147
    139148Then to start `tracd` run something like this:
     149
    140150{{{
    141151 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname
     
    143153
    144154For example:
     155
    145156{{{
    146157 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv
    147158}}}
     159
    148160''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).
    149161
    150 === Digest authentication: Using a htdigest password file ===
     162=== Using a htdigest password file ===
    151163
    152164If 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.
     
    156168=== Generating Passwords Without Apache ===
    157169
    158 Basic Authorization can be accomplished via this [http://www.4webhelp.net/us/password.php online HTTP Password generator].  Copy the generated password-hash line to the .htpasswd file on your system.
    159 
    160 You can use this simple Python script to generate a '''digest''' password file:
     170If you don't have Apache available, you can use this simple Python script to generate your passwords:
    161171
    162172{{{
     
    192202}}}
    193203
    194 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):
     204Note: 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):
    195205
    196206{{{
     
    199209}}}
    200210
    201 ==== Using `md5sum`
    202 It is possible to use `md5sum` utility to generate digest-password file:
     211
     212Note: 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). Make sure to use -m option for it.  If you do not have Apache, [trac:source:/tags/trac-0.11/contrib/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)
     213
     214It is possible to use md5sum utility to generate digest-password file using such method:
    203215{{{
    204216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
    205217}}}
    206218and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
    207 
    208 == Reference ==
    209 
    210 Here's the online help, as a reminder (`tracd --help`):
    211 {{{
    212 Usage: tracd [options] [projenv] ...
    213 
    214 Options:
    215   --version             show program's version number and exit
    216   -h, --help            show this help message and exit
    217   -a DIGESTAUTH, --auth=DIGESTAUTH
    218                         [projectdir],[htdigest_file],[realm]
    219   --basic-auth=BASICAUTH
    220                         [projectdir],[htpasswd_file],[realm]
    221   -p PORT, --port=PORT  the port number to bind to
    222   -b HOSTNAME, --hostname=HOSTNAME
    223                         the host name or IP address to bind to
    224   --protocol=PROTOCOL   http|scgi|ajp
    225   -q, --unquote         unquote PATH_INFO (may be needed when using ajp)
    226   --http10              use HTTP/1.0 protocol version (default)
    227   --http11              use HTTP/1.1 protocol version instead of HTTP/1.0
    228   -e PARENTDIR, --env-parent-dir=PARENTDIR
    229                         parent directory of the project environments
    230   --base-path=BASE_PATH
    231                         the initial portion of the request URL's "path"
    232   -r, --auto-reload     restart automatically when sources are modified
    233   -s, --single-env      only serve a single project without the project list
    234 }}}
    235219
    236220== Tips ==
     
    251235 ''Support for `htdocs:` TracLinks syntax was added in version 0.10''
    252236
    253 === Using tracd behind a proxy
    254 
    255 In some situations when you choose to use tracd behind Apache or another web server.
    256 
    257 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.
    258 
    259 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.
    260 
    261 See also [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe].
     237=== Using apache rewrite rules ===
     238In 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.
    262239
    263240=== Serving a different base path than / ===
     
    268245
    269246----
    270 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]
     247See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]