Changes between Version 1 and Version 2 of TracStandalone
- Timestamp:
- 12/14/10 11:11:30 (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v1 v2 1 1 = Tracd = 2 2 3 Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script]. 3 Tracd is a lightweight standalone Trac web server. 4 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. 4 5 5 6 == Pros == 6 7 7 8 * 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 * 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 9 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). 10 11 11 12 == Cons == 12 13 13 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD.14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd. 14 15 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 15 16 or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. … … 40 41 To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background. 41 42 43 == Installing as a Windows Service == 44 45 === Option 1 === 46 To 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 55 If you want tracd to start automatically when you boot Windows, do: 56 {{{ 57 sc config tracd start= auto 58 }}} 59 60 The spacing here is important. 61 62 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 {{{ 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 66 net start tracd 67 }}} 68 69 === Option 2 === 70 71 Use [http://trac-hacks.org/wiki/WindowsServiceScript WindowsServiceScript], available at [http://trac-hacks.org/ Trac Hacks]. Installs, removes, starts, stops, etc. your Trac service. 42 72 43 73 == Using Authentication == … … 48 78 49 79 {{{ 50 sudohtpasswd -c /path/to/env/.htpasswd username80 $ htpasswd -c /path/to/env/.htpasswd username 51 81 }}} 52 82 then for additional users: 53 83 {{{ 54 sudo htpasswd /var/www/html/.htpasswd-usersusername255 }}} 56 then for starting the tracd :84 $ htpasswd /path/to/env/.htpasswd username2 85 }}} 86 then for starting the tracd (on windows skip the "=" after --basic-auth): 57 87 {{{ 58 88 tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 59 89 }}} 60 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. 61 92 62 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.) … … 64 95 ''Support for Basic authentication was added in version 0.9.'' 65 96 66 The general format for using authentication is :67 68 {{{ 69 $ tracd -p port --auth= base_project_dir,password_file_path,realmproject_path97 The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth): 98 99 {{{ 100 $ tracd -p port --auth="base_project_dir,password_file_path,realm" project_path 70 101 }}} 71 102 72 103 where: 73 104 74 * '''base_project_dir''' is the base directory of the project; note: this doesn't refer to the project name, and it is case-sensitive even for windows environments 75 * '''password_file_path''' path of the password file 76 * '''realm''' realm 77 * '''project_path''' path of the project 78 79 Example: 105 * '''base_project_dir''': the base directory of the project specified as follows: 106 * when serving multiple projects: ''relative'' to the `project_path` 107 * when serving only a single project (`-s`): the name of the project directory 108 Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows. 109 * '''password_file_path''': path to the password file 110 * '''realm''': the realm name (can be anything) 111 * '''project_path''': path of the project 112 113 Examples: 80 114 81 115 {{{ 82 116 $ tracd -p 8080 \ 83 --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 84 }}} 85 Of course, the digest file can be be shared so that it is used for more than one project: 117 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 118 }}} 119 120 Of course, the password file can be be shared so that it is used for more than one project: 86 121 {{{ 87 122 $ tracd -p 8080 \ 88 --auth= project1,/path/to/users.htdigest,mycompany.com\89 --auth= project2,/path/to/users.htdigest,mycompany.com\123 --auth="project1,/path/to/passwordfile,mycompany.com" \ 124 --auth="project2,/path/to/passwordfile,mycompany.com" \ 90 125 /path/to/project1 /path/to/project2 91 126 }}} 92 127 93 Another way to share the digest file is to specify "*" 94 for the project name: 128 Another way to share the password file is to specify "*" for the project name: 95 129 {{{ 96 130 $ tracd -p 8080 \ 97 --auth= *,/path/to/users.htdigest,mycompany.com\131 --auth="*,/path/to/users.htdigest,mycompany.com" \ 98 132 /path/to/project1 /path/to/project2 99 133 }}} 100 134 101 == How to set up an htdigest password file == 135 === Using a htpasswd password file === 136 This section describes how to use `tracd` with Apache .htpasswd files. 137 138 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 {{{ 141 $ sudo htpasswd -c /path/to/env/.htpasswd username 142 }}} 143 then for additional users: 144 {{{ 145 $ sudo htpasswd /path/to/env/.htpasswd username2 146 }}} 147 148 Then to start `tracd` run something like this: 149 150 {{{ 151 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 152 }}} 153 154 For example: 155 156 {{{ 157 $ tracd -p 8080 --basic-auth="testenv,/srv/tracenv/testenv/.htpasswd,My Test Env" /srv/tracenv/testenv 158 }}} 159 160 ''Note:'' You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD). 161 162 === Using a htdigest password file === 102 163 103 164 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. … … 105 166 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 106 167 107 == Generating Passwords Without Apache==168 === Generating Passwords Without Apache === 108 169 109 170 If you don't have Apache available, you can use this simple Python script to generate your passwords: … … 112 173 #!python 113 174 from optparse import OptionParser 114 import md5 175 # The md5 module is deprecated in Python 2.5 176 try: 177 from hashlib import md5 178 except ImportError: 179 from md5 import md5 180 realm = 'trac' 115 181 116 182 # build the options … … 121 187 parser.add_option("-p", "--password",action="store", dest="password", type = "string", 122 188 help="the password to use") 189 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string", 190 help="the realm in which to create the digest") 123 191 (options, args) = parser.parse_args() 124 192 … … 126 194 if (options.username is None) or (options.password is None): 127 195 parser.error("You must supply both the username and password") 196 if (options.realm is not None): 197 realm = options.realm 128 198 129 199 # Generate the string to enter into the htdigest file 130 realm = 'trac' 131 kd = lambda x: md5.md5(':'.join(x)).hexdigest() 200 kd = lambda x: md5(':'.join(x)).hexdigest() 132 201 print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 133 202 }}} … … 136 205 137 206 {{{ 138 python trac-digest.py -u username -p password >> c:\digest.txt 139 tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 140 }}} 141 142 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). 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.) 207 $ python trac-digest.py -u username -p password >> c:\digest.txt 208 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name 209 }}} 210 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.) 143 213 144 214 It is possible to use md5sum utility to generate digest-password file using such method: 145 215 {{{ 146 echo -e "${user}:trac:${password}\c" | md5sum - >>to-file 147 }}} 148 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. You can see attachment:trac-digest-corrected.sh for detail.216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 217 }}} 218 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 149 219 150 220 == Tips == … … 152 222 === Serving static content === 153 223 154 If `tracd` is the only web server used for the project,224 If `tracd` is the only web server used for the project, 155 225 it can also be used to distribute static content 156 226 (tarballs, Doxygen documentation, etc.) … … 161 231 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 162 232 the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 163 which in turn can be written using the relative link syntax 164 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 165 166 The development version of Trac supports a new `htdocs:` TracLinks 167 syntax for the above. With this, the example link above can be written simply 168 `htdocs:software-0.1.tar.gz`. 233 which 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). 234 235 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 169 236 170 237 === Using apache rewrite rules === … … 172 239 173 240 === Serving a different base path than / === 174 Tracd supports serving projects with different base urls th en /<project>. The parameter name to change this is175 {{{ 176 tracd --base-path=/some/path241 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 242 {{{ 243 $ tracd --base-path=/some/path 177 244 }}} 178 245 179 246 ---- 180 See also: TracInstall, TracCgi, TracModPython, TracGuide 247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service], [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]
