| | 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 | |
| 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. |
| | 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.) |
| 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: |
| | 97 | 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 |
| | 101 | }}} |
| | 102 | |
| | 103 | where: |
| | 104 | |
| | 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: |
| | 114 | |
| 52 | | --auth project1,/path/to/users.htdigest,mycompany.com \ |
| 53 | | --auth project2,/path/to/users.htdigest,mycompany.com \ |
| | 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: |
| | 121 | {{{ |
| | 122 | $ tracd -p 8080 \ |
| | 123 | --auth="project1,/path/to/passwordfile,mycompany.com" \ |
| | 124 | --auth="project2,/path/to/passwordfile,mycompany.com" \ |
| 65 | | == 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 === |
| 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 | | }}} |
| | 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.) |
| | 213 | |
| | 214 | It is possible to use md5sum utility to generate digest-password file using such method: |
| | 215 | {{{ |
| | 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'. |
| 118 | | which in turn can be written using the relative link syntax |
| 119 | | in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` |
| 120 | | |
| 121 | | The development version of Trac supports a new `htdocs:` TracLinks |
| 122 | | syntax for the above. With this, the example link above can be written simply |
| 123 | | `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'' |
| | 236 | |
| | 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. |
| | 239 | |
| | 240 | === Serving a different base path than / === |
| | 241 | Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is |
| | 242 | {{{ |
| | 243 | $ tracd --base-path=/some/path |
| | 244 | }}} |
