# Changes between Version 1 and Version 2 of TracInstall

Show
Ignore:
Timestamp:
01/12/10 06:39:22 (3 years ago)
Comment:

--

Unmodified
Removed
Modified
• ## 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.
4
5Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://postgresql.org/ PostgreSQL], [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
6
7What 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.
8
10
11
12== Quick Install a Released Version ==
13For a quick install, first make sure you have [http://python.org/download Python] (2.3-2.6) and [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install].
14
15Then enter (''omitting 'sudo' if not applicable'')
16{{{
17sudo easy_install Trac
18}}}
19to install Trac, SQLite, and Genshi.
620
721
822== Requirements ==
23The 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.
924
1025To install Trac, the following software packages must be installed:
1126
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)
27 * [http://www.python.org/ Python], version >=2.3 (<3.0)
28   * 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).
29   * For RPM-based systems you might also need the python-devel and python-xml packages.
30   * See instructions in [trac:wiki:TracOnWindows/Python2.5 TracOnWindows/Python2.5]
31 * [wiki:setuptools], version >= 0.6
32 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
33 * You also need a database system and the corresponding python drivers for it.
34   The database can be either SQLite, PostgreSQL or MySQL.
35 * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
36
37==== For SQLite ====
38
39If you're using Python 2.5 or 2.6, you already have everything you need.
40
41If you're using Python 2.3 or 2.4 and need pysqlite, you can download from
43installers or the tar.gz archive for building from source:
44{{{
45$tar xvfz <version>.tar.gz 46$ cd <version>
47$python setup.py build_static install 48}}} 49 50That way, the latest SQLite version will be downloaded and built into the 51bindings. 52 53If you're still using SQLite 2.x, you'll need pysqlite 1.0.x, although this 54package is not easy to find anymore. For SQLite 3.x, try not to use 55pysqlite 1.1.x, which has been deprecated in favor of pysqlite 2.x. 56 57See additional information in [trac:PySqlite PySqlite]. 58 59==== For PostgreSQL ==== 60 61 * [http://www.postgresql.org/ PostgreSQL] 62 * [http://initd.org/projects/psycopg2 psycopg2] 63 * See [trac:wiki:DatabaseBackend#Postgresql DatabaseBackend] 64 65'''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. 66 67==== For MySQL ==== 68 69 * [http://mysql.com/ MySQL], version 4.1 or later ([http://askmonty.org/wiki/index.php/MariaDB MariaDB] might work as well) 70 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 71 72See [trac:MySqlDb MySqlDb] for more detailed information. 73It is ''very'' important to read carefully that page before creating the database. 74 75== Optional Requirements == 76 77==== Version Control System ==== 78 79'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported (although Windows UNC paths such as {{{\\machine_name\path\to\svn}}} do work). 80 81 * [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] 82 * 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). 83 * 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. 84 * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. 85 * Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend]. 86 87==== Web Server ==== 88 * A CGI-capable web server (see TracCgi), or 89 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 90 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or 91 * [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) or 92 * 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. 93 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 94 * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 95 96For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [trac:wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. 97 98==== Other Python Utilities ==== 99 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 100 * [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. 101 * [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. 102 103'''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]. 104 105Please 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!). 25106 26107== Installing Trac == 27 Like most Python programs, install the Trac python modules by running the following command at the top of the source directory: 108 109One way to install Trac is using setuptools. 110With setuptools you can install Trac from the subversion repository; for example, 111to install release version 0.11 do: 112{{{ 113easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11 114}}} 115 116But of course the python-typical setup at the top of the source directory also works: 28117{{{ 29118$ python ./setup.py install
30119}}}
31120
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 }}}
121''Note: you'll need root permissions or equivalent for this step.''
122
123This will byte-compile the python source code and install it as an .egg file or folder in the site-packages directory
124of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
125
126The 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.
127
129
130To install Trac to a custom location, or find out about other advanced installation options, run:
131{{{
132easy_install --help
133}}}
134
135Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
136
137Specifically, you might be interested in:
138{{{
139easy_install --prefix=/path/to/installdir
140}}}
141or, if installing Trac to a Mac OS X system:
142{{{
143easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
144}}}
145
146The 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.
48147
49148== Creating a Project Environment ==
50149
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
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: 150A [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. 151 152A new environment is created using [wiki:TracAdmin trac-admin]: 153{{{ 154$ trac-admin /path/to/myproject initenv
155}}}
156
157[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.
158
159Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
160
161''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:''
162
163  chown -R apache.apache /path/to/myproject
164
165== Running the Standalone Server ==
166
167After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
168{{{
169$tracd --port 8000 /path/to/myproject 170}}} 171 172Then, 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: 173{{{ 174$ tracd -s --port 8000 /path/to/myproject
175}}}
176
177== Running Trac on a Web Server ==
178
179Trac 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.
180
181If 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.
182
183Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
184
185==== Generating the Trac cgi-bin directory ====
186
187In order for Trac to function properly with FastCGI or mod_python, you need to have a trac.cgi file. This is an executable which loads the appropriate Python code. It can be generated using the deploy option of [wiki:TracAdmin trac-admin].
188
189There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
190{{{
191mkdir -p /usr/share/trac/projects/my-project
194mv /tmp/deploy/* /usr/share/trac
195}}}
196
197==== Setting up the Plugin Cache ====
198
199Some 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.
200
201== Configuring Authentication ==
202
203The 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:
204
205 * TracStandalone if you use the standalone server, tracd.
206 * TracCgi if you use the CGI or FastCGI methods.
207 * TracModPython if you use the mod_python method.
208
209== Automatic reference to the SVN changesets in Trac tickets ==
210
211You 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:
212 * '''Refs #123''' - to reference this changeset in #123 ticket
213 * '''Fixes #123''' - to reference this changeset and close #123 ticket with the default status ''fixed''
214
215All 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.
216
217If 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:
218
219{{{
220$cd /path/to/svn/repository/hooks 221$ mv post-commit.tmpl post-commit
222$chmod 755 post-commit 223}}} 224 225Next 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: 226 227{{{ 228REPOS="$1"
229REV="$2" 230TRAC_ENV="/path/to/your/trac/project" 231 232/usr/bin/python /usr/local/bin/trac-post-commit-hook -p "$TRAC_ENV" -r "\$REV"
233}}}
234
235Make 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].
236
237
238== Platform-specifics installations ==
239
240 * See [trac:TracInstallPlatforms TracInstallPlatforms]
75241
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
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).
109242
110243== Using Trac ==
111244
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]
245Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
246
247Keep 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.
248
249'' Enjoy! ''
250
251[trac:TracTeam The Trac Team]
130252
131253----