Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
06/17/09 18:53:29 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TabularUnified TracInstall

    v1 v2  
    1 = Trac Installation Guide = 
     1= Trac Installation Guide for 0.11 =  
    22[[TracGuideToc]] 
    33 
    4 The 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 
    5 and 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. 
    6  
     4Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system. 
     5 
     6What follows are generic instructions for installing and setting up Trac and its requirements. While you can find instructions for installing Trac on specific systems at TracInstallPlatforms on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved. 
     7 
     8== Short - Install a released version == 
     9For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above). (You also might want to install python-dev to build genshi) 
     10{{{ 
     11sudo easy_install Trac 
     12}}} 
    713 
    814== Requirements == 
     15The hardware requirements for running Trac obviously depend on the expected data volume (number of wiki pages, tickets, revisions) and traffic. Very small projects will run fine with a 500MHz processor and 128MB RAM using SQLite. In general, the more RAM, the better. A fast hard disk also helps. 
    916 
    1017To install Trac, the following software packages must be installed: 
    1118 
    12  * [http://www.python.org/ 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  * [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!) 
    16  * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.0.x 
    17  * [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)  
    18  * [http://clearsilver.net/ Clearsilver], version >= 0.9.3 
    19  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 (??) 
    20  * A CGI-capable web server (tested on [http://httpd.apache.org/ Apache] ) 
    21  
    22 === Optional Packages === 
    23  
    24  * [http://www.modpython.org/ mod_python] (see TracModPython) 
     19 * [http://www.python.org/ Python], version >= 2.3 
     20   * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details). 
     21   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 
     22   * See instructions in ["TracOnWindows/Python2.5"] 
     23 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
     24 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates) 
     25 * You also need a database system and the corresponding python drivers for it. 
     26   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
     27 * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
     28 
     29==== For SQLite ==== 
     30 
     31 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred (note: it is preinstalled in Python 2.5.2). 
     32 * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see [trac:PySqlite PySqlite] 
     33 
     34''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.'' 
     35 
     36''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{database is locked}}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).'' 
     37 
     38==== For PostgreSQL ==== 
     39 
     40 * [http://www.postgresql.org/ PostgreSQL] 
     41 * [http://initd.org/projects/psycopg2 psycopg2] 
     42 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] 
     43 
     44'''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later. 
     45 
     46==== For MySQL ==== 
     47 
     48'''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See [trac:MySqlDb MySqlDb] for more detailed information. 
     49 
     50 * [http://mysql.com/ MySQL], version 4.1 or later 
     51 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
     52 
     53== Optional Requirements == 
     54 
     55==== Version Control System ==== 
     56 
     57'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. 
     58 
     59 * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check [trac:TracSubversion TracSubversion] 
     60   * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings). 
     61   * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`. 
     62   * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.  
     63 * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. 
     64 
     65==== Web Server ==== 
     66 * A CGI-capable web server (see TracCgi), or 
     67 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 
     68 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or 
     69 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI] or http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac) 
     70    * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python. 
     71 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
     72    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
     73 
     74For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. 
     75 
     76==== Other Python Utilities ==== 
     77 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
     78 * [http://pygments.pocoo.org Pygments] for '''syntax highlighting''', although [http://silvercity.sourceforge.net/ SilverCity] >= 0.9.7 and/or [http://gnu.org/software/enscript/enscript.html GNU Enscript] are also possible. Refer to TracSyntaxColoring for details. 
     79 * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation. 
     80 
     81'''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList MailingList] or [trac:IrcChannel IrcChannel]. 
     82 
     83Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!). 
    2584 
    2685== Installing Trac == 
    27 Like most Python programs, install the Trac python modules by running the following command at the top of the source directory: 
     86 
     87One way to install Trac is using `setuptools`. 
     88With setuptools you can install Trac from the subversion repository; for example, 
     89to install release version 0.11 do: 
     90{{{ 
     91easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11 
     92}}} 
     93 
     94But of course the python-typical setup at the top of the source directory also works: 
    2895{{{ 
    2996$ python ./setup.py install 
    3097}}} 
    3198 
    32 This will byte-compile the python source code and install it in the {{{site-packages}}} directory 
    33 of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ .  
    34  
    35 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments].  
    36  
    37 The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac. 
    38  
    39 '''Note:''' you'll need root permissions or equivalent for this step. 
    40  
    41 For 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). 
    42  
    43 === Advanced Users === 
    44 To install Trac in a custom location, and view other advanced install options, run: 
    45 {{{ 
    46 $ python ./setup.py --help 
    47 }}} 
     99''Note: you'll need root permissions or equivalent for this step.'' 
     100 
     101This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     102of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 
     103 
     104The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server. 
     105 
     106==== Advanced Options ==== 
     107 
     108To install Trac to a custom location, or find out about other advanced installation options, run: 
     109{{{ 
     110easy_install --help 
     111}}} 
     112 
     113Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 
     114 
     115Specifically, you might be interested in: 
     116{{{ 
     117easy_install --prefix=/path/to/installdir 
     118}}} 
     119or, if installing Trac to a Mac OS X system: 
     120{{{ 
     121easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
     122}}} 
     123 
     124The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations. 
    48125 
    49126== Creating a Project Environment == 
    50127 
    51 TracEnvironment is the backend storage format where Trac stores 
    52 information like wiki pages, tickets, reports, settings, etc. 
    53 An environment consist of a directory containing an SQLite database,  
    54 human-readable configuration file, log-files and attachments. 
    55  
    56 A new Trac environment is created using [wiki:TracAdmin trac-admin], like: 
    57  
    58 {{{ 
    59 $ trac-admin /path/to/projectenv initenv 
    60 }}} 
    61  
    62 [wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and 
    63 where 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 
    66 directory and all the files inside. '''Remember to set the appropriate permissions.'' 
    67  
    68 The 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.  
    69  
    70 == Configuring Apache == 
    71  
    72 Make "{{{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. 
    73  
    74 Edit the apache config and add this snippet, filenames edited to match your installation: 
     128A [wiki:TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable configuration file and various other files and directories. 
     129 
     130A new environment is created using [wiki:TracAdmin trac-admin]: 
     131{{{ 
     132$ trac-admin /path/to/myproject initenv 
     133}}} 
     134 
     135[wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running. 
     136 
     137Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
     138 
     139''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:'' 
     140 
     141  chown -R apache.apache /path/to/myproject 
     142 
     143'''Warning: If the trac.cgi files are not installed where you expect, then the current documentation is insufficient; it might be necessary to use the 'deploy' command in trac-admin.  See tickets http://trac.edgewall.org/ticket/7312 and possibly http://trac.edgewall.org/ticket/6827''' 
     144 
     145== Running the Standalone Server == 
     146 
     147After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 
     148{{{ 
     149$ tracd --port 8000 /path/to/myproject 
     150}}} 
     151 
     152Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with trac you can have the standalone server skip the environment list by starting it like this: 
     153{{{ 
     154$ tracd -s --port 8000 /path/to/myproject 
     155}}} 
     156 
     157 
     158== Running Trac on a Web Server == 
     159 
     160Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python. 
     161 
     162If you're not afraid of running newer code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module isn't as extensively tested as mod_python. 
     163 
     164Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 
     165 
     166==== Setting up the Plugin Cache ==== 
     167 
     168Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHE environment variable. Refer to your server documentation for detailed instructions. 
     169 
     170== Configuring Authentication == 
     171 
     172The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages: 
     173 
     174 * TracStandalone if you use the standalone server, `tracd`. 
     175 * TracCgi if you use the CGI or FastCGI methods. 
     176 * TracModPython if you use the mod_python method. 
     177 
     178== Automatic reference to the SVN changesets in Trac tickets == 
     179 
     180You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever files are committed to the repository. The description of the commit needs to contain one of the following formulas: 
     181 * '''Refs #123''' - to reference this changeset in #123 ticket 
     182 * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed'' 
     183 
     184All you have to do is to edit the ''post-commit'' hook in your SVN repository and make it execute ''trac-post-commit-hook'' coming with Trac. 
     185 
     186If you are editing the ''post-commit'' hook for the first time you need to navigate to your SVN repository's hooks subfolder and rename existing there ''post-commit'' template: 
     187 
     188{{{ 
     189$ cd /path/to/svn/repository/hooks 
     190$ mv post-commit.tmpl post-commit 
     191$ chmod 755 post-commit 
     192}}} 
     193 
     194Next open it in any text editor and add a line with path to the Trac environment connected with this SVN repository and another line executing the ''trac-post-commit-hook'' script: 
     195 
     196{{{ 
     197REPOS="$1" 
     198REV="$2" 
     199TRAC_ENV="/path/to/your/trac/project" 
     200 
     201/usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "$REV" 
     202}}} 
     203 
     204Make sure that ''trac-post-commit-hook'' exists in above path with execution permissions for the same user which SVN is running from. This script can be found in contrib subfolder of your Trac distribution and the latest version can be always downloaded from [source:trunk/contrib/trac-post-commit-hook]. 
     205 
     206 
     207== Platform-specifics installations == 
     208 
     209 * See [trac:TracInstallPlatforms TracInstallPlatforms] 
    75210  
    76 {{{ 
    77 Alias /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 
    84 </Directory> 
    85  
    86  
    87 # Trac need to know where the database is located 
    88 <Location "/cgi-bin/trac.cgi"> 
    89         SetEnv TRAC_ENV "/path/to/projectenv" 
    90 </Location> 
    91  
    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 
    101 </Location> 
    102 }}} 
    103  
    104 '''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3). 
    105  
    106 '''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project. 
    107  
    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). 
    109211 
    110212== Using Trac == 
    111213 
    112 '''Congratulations!''' You should now have a running Trac installation at: 
    113  
    114 http://<yourhostname>/cgi-bin/trac.cgi 
    115  
    116 You should be able to browse your subversion repository, create tickets, 
    117 view the timeline and use all the features of Trac. 
    118  
    119 Keep in mind that anonymous users (not logged in) can only access a restricted subset of all Trac features by default.  
    120  
    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). 
    122  
    123 Please continue to TracPermissions to learn how to grant additional privileges to authenticated users. 
    124  
    125 For user documentation, see TracGuide. 
    126  
    127 ''Enjoy!'' 
    128  
    129 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team] 
     214Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. 
     215 
     216Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features. 
     217 
     218'' Enjoy! '' 
     219 
     220[trac:TracTeam The Trac Team] 
    130221 
    131222---- 
    132 See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython 
     223See also:  TracInstallPlatforms, TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions