Changes between Initial Version and Version 1 of TracInstall

02/11/05 11:50:06 (15 years ago)



  • TracInstall

    v1 v1  
     1= Trac Installation Guide = 
     4The Trac web-based project management tool is implemented as a CGI- or standalone program. Trac is written in the [ Python] programming language 
     5and uses the [ SQLite] embedded database for persistant storage. For HTML rendering, Trac uses the [ Clearsilver] template system. 
     8== Requirements == 
     10To install Trac, the following software packages must be installed: 
     12 * [ Python], version >= 2.1 (>=2.3 recommended). 
     13   * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages. 
     14 * [ Subversion], version >= 1.0. (>=1.1 recommended) 
     15 * [ Subversion Python bindings] (Caveat: Trac uses the [ SWIG] bindings included in the Subversion distribution,  '''not''' the  [ PySVN] package!) 
     16 * [ SQLite], version 2.8.x or 3.0.x 
     17 * [ PySQLite], version >= 0.5 but < 1.1.0 (for SQLite 2.8.x), version >= 1.1.1 (for SQLite 3.0.x) 
     18 * [ Clearsilver], version >= 0.9.3 
     19 * [ docutils], version >= 0.3.3 (??) 
     20 * A CGI-capable web server (tested on [ Apache] ) 
     22=== Optional Packages === 
     24 * [ mod_python] (see TracModPython) 
     26== Installing Trac == 
     27Like most Python programs, install the Trac python modules by running the following command at the top of the source directory: 
     29$ python ./ install 
     32This will byte-compile the python source code and install it in the {{{site-packages}}} directory 
     33of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ . 
     35The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments]. 
     37The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac. 
     39'''Note:''' you'll need root permissions or equivalent for this step. 
     41For more information on installing Trac on specific platforms, see the [ TracInstallPlatforms] page (on the main project web site). 
     43=== Advanced Users === 
     44To install Trac in a custom location, and view other advanced install options, run: 
     46$ python ./ --help 
     49== Creating a Project Environment == 
     51TracEnvironment is the backend storage format where Trac stores 
     52information like wiki pages, tickets, reports, settings, etc. 
     53An environment consist of a directory containing an SQLite database, 
     54human-readable configuration file, log-files and attachments. 
     56A new Trac environment is created using [wiki:TracAdmin trac-admin], like: 
     59$ trac-admin /path/to/projectenv initenv 
     62[wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and 
     63where it can find the trac templates directory (the default value should work for a typical install). 
     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.'' 
     68The same applies for the subversion repository files (unless using the [ FSFS Subversion backend], something we highly recommend. 
     70== Configuring Apache == 
     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. 
     74Edit the apache config and add this snippet, filenames edited to match your installation: 
     77Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac htdocs 
     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 
     87# Trac need to know where the database is located 
     88<Location "/cgi-bin/trac.cgi"> 
     89        SetEnv TRAC_ENV "/path/to/projectenv" 
     92# 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 
     96<Location "/cgi-bin/trac.cgi/login"> 
     97        AuthType Basic 
     98        AuthName "trac" 
     99        AuthUserFile /somewhere/trac.htpasswd 
     100        Require valid-user 
     104'''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3). 
     106'''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project. 
     108'''Note:''' If you are using [ Apache suEXEC] feature see [ ApacheSuexec] (on the project web site). 
     110== Using Trac == 
     112'''Congratulations!''' You should now have a running Trac installation at: 
     116You should be able to browse your subversion repository, create tickets, 
     117view the timeline and use all the features of Trac. 
     119Keep in mind that anonymous users (not logged in) can only access a restricted subset of all Trac features by default. 
     121'''Note:''' If you don't want long, and relatively ugly, URLs, you can prettify them by changing your Apache config. See [ TracPrettyUrls] (on the project website). 
     123Please continue to TracPermissions to learn how to grant additional privileges to authenticated users. 
     125For user documentation, see TracGuide. 
     129[ The Trac Team] 
     132See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython