Changes between Version 1 and Version 2 of TracStandalone


Ignore:
Timestamp:
09/10/09 19:34:29 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracStandalone

    v1 v2  
    2121 $ tracd -p 8080 /path/to/project
    2222}}}
    23 Stricly 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 }}}
    2723With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
    2824{{{
     
    3834}}}
    3935
    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.
    41 
    42 == Installing as a Windows Service ==
    43 
    44 To install as a Windows service, get the [http://www.google.com/search?q=srvany.exe SRVANY] utility and run:
    45 {{{
    46  C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
    47  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>"
    48  net start tracd
    49 }}}
    50 
    51 '''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}}}.
    52 
    53 If you want tracd to start automatically when you boot Windows, do:
    54 {{{
    55  sc config tracd start= auto
    56 }}}
    57 
    58 The spacing here is important.
    59 
    6036== Using Authentication ==
    6137
    62 Using tracd with Apache .htpasswd files:
    63 
    64 To create a .htpasswd file using htpasswd:
    65 
    66 {{{
    67 sudo htpasswd -c /path/to/env/.htpasswd username
    68 }}}
    69 then for additional users:
    70 {{{
    71 sudo htpasswd /path/to/env/.htpasswd username2
    72 }}}
    73 then for starting the tracd:
    74 {{{
    75 tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
    76 }}}
    77 
    78 
    79 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.)
     38Tracd 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.
    8039
    8140  ''Support for Basic authentication was added in version 0.9.''
    8241
    83 The general format for using authentication is:
    84 
     42If 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:
    8543{{{
    86  $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
     44 $ tracd -p 8080 --auth project1,/path/to/users.htdigest,mycompany.com /path/to/project1
    8745}}}
    8846
    89 where:
     47'''Note''': the project "name" passed to the `--auth` option is the base name of the project environment directory.
    9048
    91  * '''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
    92  * '''password_file_path''' path of the password file
    93  * '''realm''' realm
    94  * '''project_path''' path of the project
    95 
    96 Example:
    97 
    98 {{{
    99  $ tracd -p 8080 \
    100    --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
    101 }}}
    10249Of course, the digest file can be be shared so that it is used for more than one project:
    10350{{{
    10451 $ tracd -p 8080 \
    105    --auth=project1,/path/to/users.htdigest,mycompany.com \
    106    --auth=project2,/path/to/users.htdigest,mycompany.com \
     52   --auth project1,/path/to/users.htdigest,mycompany.com \
     53   --auth project2,/path/to/users.htdigest,mycompany.com \
    10754   /path/to/project1 /path/to/project2
    10855}}}
     
    11259{{{
    11360 $ tracd -p 8080 \
    114    --auth="*",/path/to/users.htdigest,mycompany.com \
     61   --auth *,/path/to/users.htdigest,mycompany.com \
    11562   /path/to/project1 /path/to/project2
    11663}}}
    117 If using the `-s` parameter for serving a Trac environment from the root of a domain, one must use `*` for the project name
    11864
    11965== How to set up an htdigest password file ==
     
    12874
    12975{{{
    130 #!python
    13176from optparse import OptionParser
    132 # The md5 module is deprecated in Python 2.5
    133 try:
    134     from hashlib import md5
    135 except ImportError:
    136     from md5 import md5
    137 realm = 'trac'
     77import md5
    13878
    13979# build the options
     
    14484parser.add_option("-p", "--password",action="store", dest="password", type = "string",
    14585                  help="the password to use")
    146 parser.add_option("-r", "--realm",action="store", dest="realm", type = "string",
    147                   help="the realm in which to create the digest")
    14886(options, args) = parser.parse_args()
    14987
     
    15189if (options.username is None) or (options.password is None):
    15290   parser.error("You must supply both the username and password")
    153 if (options.realm is not None):
    154    realm = options.realm
    15591   
    15692# Generate the string to enter into the htdigest file
    157 kd = lambda x: md5(':'.join(x)).hexdigest()
     93realm = 'trac'
     94kd = lambda x: md5.md5(':'.join(x)).hexdigest()
    15895print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
    15996}}}
     
    163100{{{
    164101python trac-digest.py -u username -p password >> c:\digest.txt
    165 tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
     102python tracd --port 8000 --auth proj_name,c:\digest.txt,trac c:\path\to\proj_name
    166103}}}
    167 
    168 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.)
    169 
    170 It is possible to use md5sum utility to generate digest-password file using such method:
    171 {{{
    172  $ printf "${user}:trac:${password}" | md5sum - >>user.htdigest
    173 }}}
    174 and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'.
    175104
    176105== Tips ==
     
    194123`htdocs:software-0.1.tar.gz`.
    195124
    196 === Using apache rewrite rules ===
    197 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.
    198 
    199 === Serving a different base path than / ===
    200 Tracd supports serving projects with different base urls than /<project>. The parameter name to change this is
    201 {{{
    202  $ tracd --base-path=/some/path
    203 }}}
     125----
     126See also: TracInstall, TracCgi, TracModPython, TracGuide
    204127
    205128----
    206 See also: TracInstall, TracCgi, TracModPython, TracGuide, [trac:TracOnWindowsStandalone?version=13#RunningTracdasservice Running tracd.exe as a Windows service]
     129'''Translation:'''
     130 * [https://opensvn.csie.org/traccgi/trac_rus/wiki/StandAloneTracForTeapot Russian] (перевод на Русский)