Changes between Version 3 and Version 4 of TracStandalone
- Timestamp:
- 01/24/11 13:44:22 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracStandalone
v3 v4 8 8 * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]). 9 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` 10 11 11 12 == Cons == … … 21 22 $ tracd -p 8080 /path/to/project 22 23 }}} 24 Stricly 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 }}} 23 28 With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/) 24 29 {{{ … … 34 39 }}} 35 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. 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. 72 36 73 == Using Authentication == 37 38 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, and omit the realm. 74 `tracd` provides support for both Basic and Digest authentication. The default is to use Digest. 39 75 40 76 ''Support for Basic authentication was added in version 0.9.'' 41 77 42 If the file `/path/to/users.htdigest` contains user accounts for project1 with the realm "mycompany.com", you'd use the following command-line to start tracd: 43 {{{ 44 $ tracd -p 8080 --auth project1,/path/to/users.htdigest,mycompany.com /path/to/project1 45 }}} 46 47 '''Note''': the project "name" passed to the `--auth` option is the base name of the project environment directory. 48 49 Of course, the digest file can be be shared so that it is used for more than one project: 78 The 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 84 where: 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 94 Examples: 95 50 96 {{{ 51 97 $ tracd -p 8080 \ 52 --auth project1,/path/to/users.htdigest,mycompany.com \ 53 --auth project2,/path/to/users.htdigest,mycompany.com \ 98 --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1 99 }}} 100 101 Of 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" \ 54 106 /path/to/project1 /path/to/project2 55 107 }}} 56 108 57 Another way to share the digest file is to specify "*" 58 for the project name: 109 Another way to share the password file is to specify "*" for the project name: 59 110 {{{ 60 111 $ tracd -p 8080 \ 61 --auth *,/path/to/users.htdigest,mycompany.com\112 --auth="*,/path/to/users.htdigest,mycompany.com" \ 62 113 /path/to/project1 /path/to/project2 63 114 }}} 64 115 65 == How to set up an htdigest password file == 116 === Using a htpasswd password file === 117 This section describes how to use `tracd` with Apache .htpasswd files. 118 119 To 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 }}} 124 then for additional users: 125 {{{ 126 $ sudo htpasswd /path/to/env/.htpasswd username2 127 }}} 128 129 Then to start `tracd` run something like this: 130 131 {{{ 132 $ tracd -p 8080 --basic-auth="projectdirname,/fullpath/environmentname/.htpasswd,realmname" /fullpath/environmentname 133 }}} 134 135 For 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 === 66 144 67 145 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. … … 69 147 Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error. 70 148 71 == Generating Passwords Without Apache==149 === Generating Passwords Without Apache === 72 150 73 151 If you don't have Apache available, you can use this simple Python script to generate your passwords: 74 152 75 153 {{{ 154 #!python 76 155 from optparse import OptionParser 77 import md5 156 # The md5 module is deprecated in Python 2.5 157 try: 158 from hashlib import md5 159 except ImportError: 160 from md5 import md5 161 realm = 'trac' 78 162 79 163 # build the options … … 84 168 parser.add_option("-p", "--password",action="store", dest="password", type = "string", 85 169 help="the password to use") 170 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string", 171 help="the realm in which to create the digest") 86 172 (options, args) = parser.parse_args() 87 173 … … 89 175 if (options.username is None) or (options.password is None): 90 176 parser.error("You must supply both the username and password") 177 if (options.realm is not None): 178 realm = options.realm 91 179 92 180 # Generate the string to enter into the htdigest file 93 realm = 'trac' 94 kd = lambda x: md5.md5(':'.join(x)).hexdigest() 181 kd = lambda x: md5(':'.join(x)).hexdigest() 95 182 print ':'.join((options.username, realm, kd([options.username, realm, options.password]))) 96 183 }}} … … 99 186 100 187 {{{ 101 python trac-digest.py -u username -p password >> c:\digest.txt 102 python tracd --port 8000 --auth proj_name,c:\digest.txt,trac c:\path\to\proj_name 103 }}} 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 192 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.) 193 194 It is possible to use md5sum utility to generate digest-password file using such method: 195 {{{ 196 $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest 197 }}} 198 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. 104 199 105 200 == Tips == … … 119 214 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 120 215 121 The development version ofTrac supports a new `htdocs:` TracLinks216 Since 0.10, Trac supports a new `htdocs:` TracLinks 122 217 syntax for the above. With this, the example link above can be written simply 123 218 `htdocs:software-0.1.tar.gz`. 124 219 220 === Using apache rewrite rules === 221 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. 222 223 === Serving a different base path than / === 224 Tracd 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 125 229 ---- 126 See also: TracInstall, TracCgi, TracModPython, TracGuide 127 128 ---- 129 '''Translation:''' 130 * [https://opensvn.csie.org/traccgi/trac_rus/wiki/StandAloneTracForTeapot Russian] (перевод на Русский) 230 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]
