Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
11/17/04 15:27:55 (20 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v1 v2  
    33The Trac web-based project management tool is implemented as a server
    44side cgi-program. Trac is written in the Python programming language
    5 and store it's data in a sqlite database.
     5and uses SQLite as an embedded database. For HTML rendering, Trac uses the Clearsilver template system.
    66
    7 == Dependencies ==
    87
    9 The following dependencies have to be installed:
     8== Requirements ==
     9
     10To install Trac, the following software packages must be installed:
    1011
    1112 * [http://www.python.org/ Python], version >= 2.1.
    12  * [http://subversion.tigris.org/ subversion], version >= 0.37.
    13  * [http://pysqlite.sf.net/ pysqlite], version >= 0.4.3 (>= 0.5 for better performance)
    14  * [http://clearsilver.net/ ClearSilver], version >= 0.9.3
    15  * A CGI-capable web server (only tested with Apache)
     13   * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages.
     14 * [http://subversion.tigris.org/ Subversion], version >= 0.37. (>=1.0.1 recommended)
     15 * [http://subversion.tigris.org/ Subversion Python bindings].
     16 * [http://pysqlite.sf.net/ PySQLite], version >= 0.4.3 (>= 0.5 for better performance)
     17 * [http://clearsilver.net/ Clearsilver], version >= 0.9.3
     18 * A CGI-capable web server (we QA-test on [http://httpd.apache.org/ Apache2] )
    1619
    1720== Installing Trac ==
    1821{{{
    19         $ python ./setup.py install
     22$ python ./setup.py install
    2023}}}
    2124
    2225This will byte-compile the python source code and install it in the {{{site-packages}}} directory
    23 of your python installation. The directories {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}}
    24 will be copied into $prefix/share/trac/ .
     26of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ .
    2527
    26 == Initializing the database ==
     28The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain project
     29environments. Trac-admin is the ''command center'' of Trac.
    2730
    28 Trac stores wiki pages, tickets and other information in a sqlite database.
    29 Sqlite databases are just ordinary files on the hard drive, no database server
    30 is required.
     31'''Note:''' you'll need root permissions or equivalent for this step.
    3132
    32 A new trac database can be created like this:
     33For more information on installing Trac on specific platforms, see:
     34
     35 * TracOnOsx
     36 * TracOnMandrakelinux
     37 * TracOnGentoo
     38 * TracOnFreeBsd
     39 * TracOnNetBsd
     40 * TracOnDebian
     41 * TracOnWindows
     42 * TracOnRedhat
     43
     44=== Advanced Users ===
     45To install Trac in a different location, and other advanced installation options, run:
     46{{{
     47$ python ./setup.py --help
     48}}}
     49
     50== Creating a Project Environment ==
     51
     52''Trac Environment'' is the backend storage format where Trac stores
     53information like wiki pages, tickets, reports, settings, etc.
     54A Trac environment consist of a directory containing an SQLite database,
     55human-readable configuration file, log-files and attachments.
     56
     57A new Trac environment is created with {{{trac-admin}}}:
    3358
    3459{{{
    35         $ trac-admin /path/to/mydatabase.db initdb
     60$ trac-admin /path/to/projectenv initenv
    3661}}}
     62'''Note:''' The web server user need write permission to the environment
     63directory and all the files inside.
    3764
    38 NOTE: The database file have to be located in a directory where the web server
    39 user has write permission to both the file and the directory.
    40 
    41 {{{[wiki:TracAdmin trac-admin]}}} will ask you where your subversion repository is located and
     65[wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
    4266where it can find the trac templates directory (the default value should be fine).
    4367
    4468== Configuring Apache ==
    4569
    46 copy (or symlink) "{{{trac/cgi-bin/trac.cgi}}}" to
    47 you web servers {{{/cgi-bin/}}} directory. Of course you can configure apache
    48 to use the "{{{trac/cgi-bin/}}}" directory directly if you like.
     70Copy (or symlink) "{{{trac/cgi-bin/trac.cgi}}}" to
     71you web servers {{{/cgi-bin/}}} directory. You can also configure apache
     72to use the "{{{trac/cgi-bin/}}}" directory directly if you like, it's a matter of taste.
    4973
    50 Finally adjust the filenames and add this config snippet to your web server:
     74Finally edit the apache config and add this config snippet, with filenams edited to match your installation:
    5175 
    5276{{{
    53 Alias /trac/ "/where/you/put/trac/htdocs/"
     77Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac docs
     78#You have to allow people to read the files in htdocs
     79<Directory "/usr/share/trac/htdocs/">
     80        Options Indexes MultiViews
     81        AllowOverride None
     82        Order allow,deny
     83        Allow from all
     84</Directory>
     85
     86
    5487# Trac need to know where the database is located
    5588<Location "/cgi-bin/trac.cgi">
    56         SetEnv TRAC_DB "/somewhere/myproject.db"
     89        SetEnv TRAC_ENV "/path/to/projectenv"
    5790</Location>
    5891
    5992# You need this to allow users to authenticate
     93# trac.htpasswd can be created with
     94# cmd 'htpasswd -c trac.htpasswd' (UNIX)
     95# do 'man htpasswd' to see all the options
    6096<Location "/cgi-bin/trac.cgi/login">
    6197        AuthType Basic
    … …  
    66102}}}
    67103
    68 == What next? ==
     104'''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
     105
     106== Using Trac ==
    69107
    70108You should now have a working Trac installation at:
    … …  
    73111
    74112There you should be able to browse your subversion repository, create tickets,
    75 view the timeline etc. Keep in mind that anonymous users (before logging in)
    76 are only able to see/use a subset of all the features provided by Trac.
    77 Please read TracPermissions on how to grant additional privileges to authenticated users.
     113view the timeline etc. Keep in mind that anonymous users (not logged in)
     114can only access a restricted subset of all Trac features.
    78115
    79 Enjoy!
     116Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    80117
     118For further user-documentation, see TracGuide.
    81119
    82 See also:  TracGuide, TracOnNetBsd, TracOnOsx
     120''Enjoy!''
     121
     122----
     123See also:  TracGuide, TracPermissions, TracOnFreeBsd, TracOnNetBsd, TracOnOsx, TracOnMandrakelinux, TracOnDebian, TracOnGentoo