Edgewall Software

Changes between Version 71 and Version 72 of TracInstall


Ignore:
Timestamp:
Nov 14, 2004, 11:57:20 PM (19 years ago)
Author:
daniel
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v71 v72  
    22[[TracGuideToc]]
    33
    4 The Trac web-based project management tool is implemented as a server
    5 side cgi-program. Trac is written in the Python programming language
    6 and uses SQLite as an embedded database. For HTML rendering, Trac uses the Clearsilver template system.
     4The Trac web-based project management tool is implemented as a CGI- or standalone program. Trac is written in the [http://www.python.org/ Python] programming language
     5and uses the [http://www.sqlite.org/ SQLite] embedded database for persistant storage. For HTML rendering, Trac uses the [http://www.clearsilver.net/ Clearsilver] template system.
    76
    87
    … …  
    1110To install Trac, the following software packages must be installed:
    1211
    13  * [http://www.python.org/ Python], version >= 2.1.
     12 * [http://www.python.org/ Python], version >= 2.1 (>=2.3 recommended).
    1413   * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages.
    15  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (>=1.0.5 recommended)
    16  * [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Subversion Python bindings] (Caveat: Trac uses the SWIG bindings that come with the Subversion distribution, and not the  [http://pysvn.tigris.org/ PySVN bindings]!)
     14 * [http://subversion.tigris.org/ Subversion], version >= 1.0. (>=1.1 recommended)
     15 * [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Subversion Python bindings] (Caveat: Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution,  '''not''' the  [http://pysvn.tigris.org/ PySVN] package!)
    1716 * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.0.x
    1817 * [http://pysqlite.sf.net/ PySQLite], version >= 0.5 but < 1.1.0 (for SQLite 2.8.x), version >= 1.1.1 (for SQLite 3.0.x)
    1918 * [http://clearsilver.net/ Clearsilver], version >= 0.9.3
    20  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 ??
    21  * A CGI-capable web server (we QA-test on [http://httpd.apache.org/ Apache2] )
     19 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 (??)
     20 * A CGI-capable web server (tested on [http://httpd.apache.org/ Apache] )
    2221
    23 == Optional ==
     22=== Optional Packages ===
    2423
    2524 * [http://www.modpython.org/ mod_python] (see ModPython)
    2625
    2726== Installing Trac ==
     27Like most Python programs, install the Trac python modules by running the following command at the top of the source directory:
    2828{{{
    2929$ python ./setup.py install
    … …  
    3333of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ .
    3434
    35 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain project
    36 environments. Trac-admin is the ''command center'' of Trac.
     35The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments].
     36
     37The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac.
    3738
    3839'''Note:''' you'll need root permissions or equivalent for this step.
    3940
    40 For more information on installing Trac on specific platforms, see:
    41 
    42  * TracOnOsx
    43  * TracOnMandrakelinux
    44  * TracOnGentoo
    45  * TracOnFreeBsd
    46  * TracOnNetBsd
    47  * TracOnDebian
    48  * TracOnWindows
    49  * TracOnWindowsIis
    50  * [wiki:TracOnWindowsIis6 TracOnWindowsIis6]
    51  * TracOnRedhat
    52  * TracOnFedoraCore
    53  * [wiki:TracOnSuSE TracOnSuSE]
    54  * TracOnSlackware
     41For more information on installing Trac on specific platforms, see the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms TracInstallPlatforms] page (on the main project web site).
    5542
    5643=== Advanced Users ===
    57 To install Trac in a different location, and other advanced installation options, run:
     44To install Trac in a custom location, and view other advanced install options, run:
    5845{{{
    5946$ python ./setup.py --help
    … …  
    6249== Creating a Project Environment ==
    6350
    64 ''Trac Environment'' is the backend storage format where Trac stores
     51TracEnvironment is the backend storage format where Trac stores
    6552information like wiki pages, tickets, reports, settings, etc.
    66 A Trac environment consist of a directory containing an SQLite database,
     53An environment consist of a directory containing an SQLite database,
    6754human-readable configuration file, log-files and attachments.
    6855
    69 A new Trac environment is created with {{{trac-admin}}}:
     56A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
    7057
    7158{{{
    7259$ trac-admin /path/to/projectenv initenv
    7360}}}
    74 '''Note:''' The web server user need write permission to the environment
    75 directory and all the files inside. Same applies for the subversion repository files.
    7661
    7762[wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
    78 where it can find the trac templates directory (the default value should be fine).
     63where it can find the trac templates directory (the default value should work for a typical install).
     64
     65'''Note:''' The web server user will require file system write permission to the environment
     66directory and all the files inside. '''Remember to set the appropriate permissions.''
     67
     68The same applies for the subversion repository files (unless using the [http://svn.collab.net/repos/svn/trunk/notes/fsfs FSFS Subversion backend], something we highly recommend.
    7969
    8070== Configuring Apache ==
    8171
    82 Copy (or symlink) "{{{trac/cgi-bin/trac.cgi}}}" to
    83 you web servers {{{/cgi-bin/}}} directory. You can also configure apache
    84 to use the "{{{trac/cgi-bin/}}}" directory directly if you like, it's a matter of taste.
     72Make "{{{trac/cgi-bin/trac.cgi}}}" accessible to your web server at {{{/cgi-bin/}}}, either by copying/symlinking or use the "{{{trac/cgi-bin/}}}" directory directly.
    8573
    86 Finally edit the apache config and add this config snippet, with filenames edited to match your installation:
     74Edit the apache config and add this snippet, filenames edited to match your installation:
    8775 
    8876{{{
    … …  
    114102}}}
    115103
    116 If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3).
     104'''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3).
    117105
    118106'''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
    119107
    120 '''Note:''' If you are using [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature see ApacheSuexec.
     108'''Note:''' If you are using [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature see [http://projects.edgewall.com/trac/wiki/ApacheSuexec ApacheSuexec] (on the project web site).
    121109
    122110== Using Trac ==
    123111
    124 You should now have a working Trac installation at:
     112'''Congratulations!''' You should now have a running Trac installation at:
    125113
    126114http://<yourhostname>/cgi-bin/trac.cgi
    127115
    128 IF you would like the url to be like:
    129 http://<yourhostname>/
    130 or (maybe with a subdomain):
    131 http://<subdomain>.<yourhostname>/
    132 this worked for me:
     116You should be able to browse your subversion repository, create tickets,
     117view the timeline and use all the features of Trac.
    133118
    134 load the module mod_rewrite
    135 then, place this in your apache config:
    136 (if you have subdomain, inside a !VirtualHost)
    137 {{{
    138 RewriteEngine On
    139 <Location "/cgi-bin/trac.cgi">
    140         SetEnv TRAC_ENV "/path/to/trac/env"
    141 </Location>
     119Keep in mind that anonymous users (not logged in) can only access a restricted subset of all Trac features by default.
    142120
    143 ServerName <hostname>
    144 Alias /trac "/usr/share/trac/htdocs"
    145 
    146 ScriptAlias /cgi-bin /path/to/cgi-bin
    147 RewriteRule ^/$ /cgi-bin/trac.cgi [R]
    148 }}}
    149 
    150 There you should be able to browse your subversion repository, create tickets,
    151 view the timeline etc. Keep in mind that anonymous users (not logged in)
    152 can only access a restricted subset of all Trac features.
     121'''Note:''' If you don't want long, and relatively ugly, URLs, you can prettify them by changing your Apache config. See [http://projects.edgewall.com/trac/wiki/TracPrettyUrls TracPrettyUrls] (on the project website).
    153122
    154123Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    155124
    156 For further user-documentation, see TracGuide.
     125For user documentation, see TracGuide.
    157126
    158127''Enjoy!''
    159128
     129[http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     130
    160131----
    161 See also:  TracGuide, TracUpgrade, TracPermissions, TracOnFreeBsd, TracOnNetBsd, TracOnOsx, TracOnMandrakelinux, TracOnDebian, TracOnGentoo, TracOnRedhat, TracOnFedoraCore, [wiki:TracOnSuSE TracOnSuSE], TracOnWindows, TracOnSlackware
     132See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms