Changes between Version 2 and Version 3 of TracStandalone
- Timestamp:
- Mar 4, 2011, 2:02:10 PM (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v2 v3 60 60 The spacing here is important. 61 61 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 62 75 For 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 76 {{{ … … 73 86 == Using Authentication == 74 87 75 Using tracd with Apache .htpasswd files: 76 77 To create a .htpasswd file using htpasswd: 78 79 {{{ 80 $ htpasswd -c /path/to/env/.htpasswd username 81 }}} 82 then for additional users: 83 {{{ 84 $ htpasswd /path/to/env/.htpasswd username2 85 }}} 86 then for starting the tracd (on windows skip the "=" after --basic-auth): 87 {{{ 88 tracd -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 93 Tracd 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 97 The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth): 98 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: 99 91 {{{ 100 92 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 101 93 }}} 102 103 94 where: 104 105 95 * '''base_project_dir''': the base directory of the project specified as follows: 106 96 * when serving multiple projects: ''relative'' to the `project_path` … … 111 101 * '''project_path''': path of the project 112 102 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 113 105 Examples: 114 106 … … 133 125 }}} 134 126 135 === Using a htpasswd password file ===127 === Basic Authorization: Using a htpasswd password file === 136 128 This section describes how to use `tracd` with Apache .htpasswd files. 137 129 138 130 To create a .htpasswd file use Apache's `htpasswd` command (see [#GeneratingPasswordsWithoutApache below] for a method to create these files without using Apache): 139 140 131 {{{ 141 132 $ sudo htpasswd -c /path/to/env/.htpasswd username … … 147 138 148 139 Then to start `tracd` run something like this: 149 150 140 {{{ 151 141 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname … … 153 143 154 144 For example: 155 156 145 {{{ 157 146 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 158 147 }}} 159 160 148 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 161 149 162 === Using a htdigest password file ===150 === Digest authentication: Using a htdigest password file === 163 151 164 152 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 [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. … … 168 156 === Generating Passwords Without Apache === 169 157 170 If you don't have Apache available, you can use this simple Python script to generate your passwords: 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: 171 161 172 162 {{{ … … 202 192 }}} 203 193 204 Note: 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):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): 205 195 206 196 {{{ … … 209 199 }}} 210 200 211 212 Note: 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 214 It is possible to use md5sum utility to generate digest-password file using such method: 201 ==== Using `md5sum` 202 It is possible to use `md5sum` utility to generate digest-password file: 215 203 {{{ 216 204 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 217 205 }}} 218 206 and 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 }}} 219 235 220 236 == Tips == … … 235 251 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 236 252 237 === Using apache rewrite rules === 238 In 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. 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]. 239 262 240 263 === Serving a different base path than / === … … 245 268 246 269 ---- 247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone ?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]270 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone#RunningTracdasservice Running tracd.exe as a Windows service]
