Changes between Version 1 and Version 2 of TracStandalone

Timestamp:

Sep 2, 2010 9:48:15 AM (15 years ago)

Author:

trac

Comment:

--

TracStandalone

@@ -8 +8 @@
  * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
  * 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).
+  * Options for tracd: `-r, --auto-reload`
 
 == Cons ==
@@ -21 +22 @@
  $ tracd -p 8080 /path/to/project
 }}}
+Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
+{{{
+ $ tracd --hostname=localhost -p 8080 /path/to/project
+}}}
 With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
 {{{
@@ -34 +39 @@
 }}}
 
+To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
+
+== Installing as a Windows Service ==
+
+To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
+{{{
+ C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
+ 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>"
+ net start tracd
+}}}
+
+'''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}}}.
+
+If you want tracd to start automatically when you boot Windows, do:
+{{{
+ sc config tracd start= auto
+}}}
+
+The spacing here is important.
+
 == Using Authentication ==
 
-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.
+Using tracd with Apache .htpasswd files:
+
+To create a .htpasswd file using htpasswd:
+
+{{{
+ $ sudo htpasswd -c /path/to/env/.htpasswd username
+}}}
+then for additional users:
+{{{
+ $ sudo htpasswd /path/to/env/.htpasswd username2
+}}}
+then for starting the tracd (on windows skip the "=" after --basic-auth):
+{{{
+ $ tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
+}}}
+
+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.)
 
   ''Support for Basic authentication was added in version 0.9.''
 
-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:
-{{{
- $ tracd -p 8080 --auth project1,/path/to/users.htdigest,mycompany.com /path/to/project1
-}}}
-
-'''Note''': the project "name" passed to the `--auth` option is the base name of the project environment directory.
-
+The general format for using authentication is (on windows skip the "=" after --auth):
+
+{{{
+ $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
+}}}
+
+where:
+
+ * '''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
+ * '''password_file_path''' path of the password file
+ * '''realm''' realm
+ * '''project_path''' path of the project
+
+Example (on windows skip the "=" after --auth):
+
+{{{
+ $ tracd -p 8080 \
+   --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
+}}}
 Of course, the digest file can be be shared so that it is used for more than one project:
 {{{
  $ tracd -p 8080 \
-   --auth project1,/path/to/users.htdigest,mycompany.com \
-   --auth project2,/path/to/users.htdigest,mycompany.com \
+   --auth=project1,/path/to/users.htdigest,mycompany.com \
+   --auth=project2,/path/to/users.htdigest,mycompany.com \
    /path/to/project1 /path/to/project2
 }}}
@@ -59 +112 @@
 {{{
  $ tracd -p 8080 \
-   --auth *,/path/to/users.htdigest,mycompany.com \
+   --auth="*",/path/to/users.htdigest,mycompany.com \
    /path/to/project1 /path/to/project2
 }}}
+If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
 
 == How to set up an htdigest password file ==
@@ -74 +128 @@
 
 {{{
+#!python
 from optparse import OptionParser
-import md5
+# The md5 module is deprecated in Python 2.5
+try:
+    from hashlib import md5
+except ImportError:
+    from md5 import md5
+realm = 'trac'
 
 # build the options
@@ -84 +144 @@
 parser.add_option("-p", "--password",action="store", dest="password", type = "string",
                   help="the password to use")
+parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
+                  help="the realm in which to create the digest")
 (options, args) = parser.parse_args()
 
@@ -89 +151 @@
 if (options.username is None) or (options.password is None):
    parser.error("You must supply both the username and password")
+if (options.realm is not None):
+   realm = options.realm
    
 # Generate the string to enter into the htdigest file
-realm = 'trac'
-kd = lambda x: md5.md5(':'.join(x)).hexdigest()
+kd = lambda x: md5(':'.join(x)).hexdigest()
 print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
 }}}
@@ -99 +162 @@
 
 {{{
-python trac-digest.py -u username -p password >> c:\digest.txt
-python tracd --port 8000 --auth proj_name,c:\digest.txt,trac c:\path\to\proj_name
-}}}
+ $ python trac-digest.py -u username -p password >> c:\digest.txt
+ $ tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
+}}}
+
+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.)
+
+It is possible to use md5sum utility to generate digest-password file using such method:
+{{{
+ $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
+}}}
+and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
 
 == Tips ==
@@ -119 +190 @@
 in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 
 
-The development version of Trac supports a new `htdocs:` TracLinks 
+Since 0.10, Trac supports a new `htdocs:` TracLinks 
 syntax for the above. With this, the example link above can be written simply 
 `htdocs:software-0.1.tar.gz`. 
 
+=== Using apache rewrite rules ===
+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.
+
+=== Serving a different base path than / ===
+Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
+{{{
+ $ tracd --base-path=/some/path
+}}}
+
 ----
-See also: TracInstall, TracCgi, TracModPython, TracGuide
-
-----
-'''Translation:'''
- * [https://opensvn.csie.org/traccgi/trac_rus/wiki/StandAloneTracForTeapot Russian] (перевод на Русский)
+See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]