Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
Jul 9, 2009, 4:57:38 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v2  
    2121 $ tracd -p 8080 /path/to/project
    2222}}}
     23Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
     24{{{
     25 $ tracd --hostname=localhost -p 8080 /path/to/project
     26}}}
    2327With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
    2428{{{
     
    3438}}}
    3539
     40To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.
     41
     42When 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.
     43
     44
    3645== Using Authentication ==
    3746
    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.
     47Using tracd with Apache .htpasswd files:
     48
     49To create a .htpasswd file using htpasswd:
     50
     51{{{
     52sudo htpasswd -c /path/to/env/.htpasswd username
     53}}}
     54then for additional users:
     55{{{
     56sudo htpasswd /path/to/env/.htpasswd username2
     57}}}
     58then for starting the tracd:
     59{{{
     60tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
     61}}}
     62
     63
     64Tracd 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.)
    3965
    4066  ''Support for Basic authentication was added in version 0.9.''
    4167
    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:
     68The general format for using authentication is:
     69
    4370{{{
    44  $ tracd -p 8080 --auth project1,/path/to/users.htdigest,mycompany.com /path/to/project1
     71 $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
    4572}}}
    4673
    47 '''Note''': the project "name" passed to the `--auth` option is the base name of the project environment directory.
     74where:
    4875
     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
     80
     81Example:
     82
     83{{{
     84 $ tracd -p 8080 \
     85   --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
     86}}}
    4987Of course, the digest file can be be shared so that it is used for more than one project:
    5088{{{
    5189 $ tracd -p 8080 \
    52    --auth project1,/path/to/users.htdigest,mycompany.com \
    53    --auth project2,/path/to/users.htdigest,mycompany.com \
     90   --auth=project1,/path/to/users.htdigest,mycompany.com \
     91   --auth=project2,/path/to/users.htdigest,mycompany.com \
    5492   /path/to/project1 /path/to/project2
    5593}}}
     
    5997{{{
    6098 $ tracd -p 8080 \
    61    --auth *,/path/to/users.htdigest,mycompany.com \
     99   --auth="*",/path/to/users.htdigest,mycompany.com \
    62100   /path/to/project1 /path/to/project2
    63101}}}
     102If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
    64103
    65104== How to set up an htdigest password file ==
     
    74113
    75114{{{
     115#!python
    76116from optparse import OptionParser
    77 import md5
     117# The md5 module is deprecated in Python 2.5
     118try:
     119    from hashlib import md5
     120except ImportError:
     121    from md5 import md5
     122realm = 'trac'
    78123
    79124# build the options
     
    84129parser.add_option("-p", "--password",action="store", dest="password", type = "string",
    85130                  help="the password to use")
     131parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
     132                  help="the realm in which to create the digest")
    86133(options, args) = parser.parse_args()
    87134
     
    89136if (options.username is None) or (options.password is None):
    90137   parser.error("You must supply both the username and password")
     138if (options.realm is not None):
     139   realm = options.realm
    91140   
    92141# Generate the string to enter into the htdigest file
    93 realm = 'trac'
    94 kd = lambda x: md5.md5(':'.join(x)).hexdigest()
     142kd = lambda x: md5(':'.join(x)).hexdigest()
    95143print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
    96144}}}
     
    100148{{{
    101149python 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
     150tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
    103151}}}
     152
     153Note: 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.)
     154
     155It is possible to use md5sum utility to generate digest-password file using such method:
     156{{{
     157echo -e "${user}:trac:${password}\c" | md5sum - >>to-file
     158}}}
     159and 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.
    104160
    105161== Tips ==
     
    123179`htdocs:software-0.1.tar.gz`.
    124180
    125 ----
    126 See also: TracInstall, TracCgi, TracModPython, TracGuide
     181=== Using apache rewrite rules ===
     182In 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.
     183
     184=== Serving a different base path than / ===
     185Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
     186{{{
     187tracd --base-path=/some/path
     188}}}
    127189
    128190----
    129 '''Translation:'''
    130  * [https://opensvn.csie.org/traccgi/trac_rus/wiki/StandAloneTracForTeapot Russian] (перевод на Русский)
     191See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]