Changes between Version 1 and Version 2 of TracStandalone
- Время:
- 13 апр. 2009 г., 12:52:51 (17 лет назад)
Обозначения:
- Без изменений
- Добавлено
- Удалено
- Изменено
-
TracStandalone
v1 v2 1 1 = Tracd = 2 2 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. 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]. 5 4 6 5 == Pros == 7 6 8 7 * 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 default8 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]). 10 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). 11 10 12 11 == Cons == 13 12 14 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache httpd.13 * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD. 15 14 * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead, 16 15 or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy. … … 41 40 To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background. 42 41 43 == Installing as a Windows Service == 42 When running as a Windows service using a utility such as [http://www.google.com/search?q=srvany.exe SRVANY], stopping or restarting the service will also leave a Python process running -- restart the system instead. 44 43 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.exe49 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 tracd51 }}}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= auto58 }}}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 tracd67 }}}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.72 44 73 45 == Using Authentication == … … 78 50 79 51 {{{ 80 $htpasswd -c /path/to/env/.htpasswd username52 sudo htpasswd -c /path/to/env/.htpasswd username 81 53 }}} 82 54 then for additional users: 83 55 {{{ 84 $htpasswd /path/to/env/.htpasswd username256 sudo htpasswd /path/to/env/.htpasswd username2 85 57 }}} 86 then for starting the tracd (on windows skip the "=" after --basic-auth):58 then for starting the tracd: 87 59 {{{ 88 60 tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname 89 61 }}} 90 62 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 63 93 64 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.) … … 95 66 ''Support for Basic authentication was added in version 0.9.'' 96 67 97 The general format for using authentication is (replace `--auth` with `--basic-auth` if you want to use Basic auth):68 The general format for using authentication is: 98 69 99 70 {{{ 100 $ tracd -p port --auth= "base_project_dir,password_file_path,realm"project_path71 $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path 101 72 }}} 102 73 103 74 where: 104 75 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 76 * '''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 77 * '''password_file_path''' path of the password file 78 * '''realm''' realm 79 * '''project_path''' path of the project 112 80 113 Example s:81 Example: 114 82 115 83 {{{ 116 $ tracd -p 8080 \117 --auth= "project1,/path/to/passwordfile,mycompany.com"/path/to/project184 $ tracd -p 8080 85 --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1 118 86 }}} 119 120 Of course, the password file can be be shared so that it is used for more than one project: 87 Of course, the digest file can be be shared so that it is used for more than one project: 121 88 {{{ 122 $ tracd -p 8080 \123 --auth= "project1,/path/to/passwordfile,mycompany.com" \124 --auth= "project2,/path/to/passwordfile,mycompany.com" \89 $ tracd -p 8080 90 --auth=project1,/path/to/users.htdigest,mycompany.com 91 --auth=project2,/path/to/users.htdigest,mycompany.com 125 92 /path/to/project1 /path/to/project2 126 93 }}} 127 94 128 Another way to share the password file is to specify "*" for the project name: 95 Another way to share the digest file is to specify "*" 96 for the project name: 129 97 {{{ 130 $ tracd -p 8080 \131 --auth="* ,/path/to/users.htdigest,mycompany.com" \98 $ tracd -p 8080 99 --auth="*",/path/to/users.htdigest,mycompany.com 132 100 /path/to/project1 /path/to/project2 133 101 }}} 102 If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name 134 103 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 === 104 == How to set up an htdigest password file == 163 105 164 106 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. … … 166 108 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 167 109 168 == = Generating Passwords Without Apache ===110 == Generating Passwords Without Apache == 169 111 170 112 If you don't have Apache available, you can use this simple Python script to generate your passwords: … … 205 147 206 148 {{{ 207 $ python trac-digest.py -u username -p password >> c:\digest.txt208 $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name149 python trac-digest.py -u username -p password >> c:digest.txt 150 tracd --port 8000 --auth=proj_name,c:digest.txt,trac c:path oproj_name 209 151 }}} 210 152 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.) 153 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.) 213 154 214 155 It is possible to use md5sum utility to generate digest-password file using such method: 215 156 {{{ 216 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 157 echo -e "${user}:trac:${password}c" | md5sum - >>to-file 217 158 }}} 218 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 159 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. 219 160 220 161 == Tips == … … 222 163 === Serving static content === 223 164 224 If `tracd` is the only web 165 If `tracd` is the only webserver used for the project, 225 166 it can also be used to distribute static content 226 167 (tarballs, Doxygen documentation, etc.) … … 231 172 Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file, 232 173 the corresponding relative URL would be `/<project_name>/chrome/site/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). 174 which in turn can be written using the relative link syntax 175 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 234 176 235 ''Support for `htdocs:` TracLinks syntax was added in version 0.10'' 177 The development version of Trac supports a new `htdocs:` TracLinks 178 syntax for the above. With this, the example link above can be written simply 179 `htdocs:software-0.1.tar.gz`. 236 180 237 181 === Using apache rewrite rules === … … 241 185 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is 242 186 {{{ 243 $tracd --base-path=/some/path187 tracd --base-path=/some/path 244 188 }}} 245 189 246 190 ---- 247 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service] , [trac:TracOnWindowsIisAjp], [trac:TracNginxRecipe]191 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]
