Edgewall Software

Changes between Initial Version and Version 1 of 0.13/TracInstall


Ignore:
Timestamp:
Sep 1, 2010, 10:24:25 PM (12 years ago)
Author:
Christian Boos
Comment:

copied from TracInstall@314

Legend:

Unmodified
Added
Removed
Modified
  • 0.13/TracInstall

    v1 v1  
     1{{{
     2#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
     3
     4  '''NOTE: this page is for 0.13, the "next" version. \\
     5  For installing previous Trac versions, please refer to TracInstall (for Trac 0.12) or even [[0.11/TracInstall]]'''
     6}}}
     7= Trac Installation Guide for 0.12 =
     8[[TracGuideToc]]
     9
     10Trac 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.
     11
     12Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default english version, as usual.
     13
     14If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
     15
     16What follows are generic instructions for installing and setting up Trac and its requirements. While you may 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.
     17
     18[[PageOutline(2-3,Installation Steps,inline)]]
     19
     20== Dependencies ==
     21=== Mandatory Dependencies
     22To install Trac, the following software packages must be installed:
     23
     24 * [http://www.python.org/ Python], version >= 2.4 and < 3.0
     25   (note that we dropped the support for Python 2.3 in this release)
     26 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     27 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     28
     29You also need a database system and the corresponding python bindings.
     30The database can be either SQLite, PostgreSQL or MySQL.
     31
     32==== For the SQLite database #ForSQLite
     33
     34If you're using Python 2.5 or 2.6, you already have everything you need.
     35
     36If you're using Python 2.4 and need pysqlite, you can download from
     37[http://code.google.com/p/pysqlite/downloads/list google code] the Windows
     38installers or the tar.gz archive for building from source:
     39{{{
     40$ tar xvfz <version>.tar.gz
     41$ cd <version>
     42$ python setup.py build_static install
     43}}}
     44 
     45This will extract the SQLite code and build the bindings.
     46
     47SQLite 2.x is no longer supported.
     48
     49A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     50from 0.11.x to 0.12. Please use a versions 2.5.5 and newer or 2.5.1 and
     51older. See #9434 for more detail.
     52
     53See additional information in [trac:PySqlite PySqlite].
     54
     55==== For the PostgreSQL database #ForPostgreSQL
     56
     57You need to install the database and its Python bindings:
     58 * [http://www.postgresql.org/ PostgreSQL]
     59 * [http://pypi.python.org/pypi/psycopg2 psycopg2]
     60
     61See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     62
     63
     64==== For the MySQL database #ForMySQL
     65
     66Trac can now work quite well with MySQL, provided you follow the guidelines.
     67
     68 * [http://mysql.com/ MySQL], version 5.0 or later
     69 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     70
     71It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     72
     73=== Optional Dependencies
     74
     75==== Version Control System ====
     76
     77===== Subversion =====
     78 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     79
     80There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
     81
     82Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?]
     83
     84
     85'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     86
     87
     88===== Others =====
     89
     90Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
     91
     92==== Web Server ====
     93A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     94
     95Alternatively you configure Trac to run in any of the following environments.
     96 * [http://httpd.apache.org/ Apache] with
     97   - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and
     98     http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
     99   - [http://modpython.org/ mod_python 3.3.1], deprecated: see TracModPython)
     100 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
     101 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     102   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     103 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     104   is highly discouraged''', better use one of the previous options.
     105   
     106
     107==== Other Python Packages ====
     108
     109 * [http://babel.edgewall.org Babel], version >= 0.9.5,
     110   needed for localization support
     111 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
     112   for WikiRestructuredText.
     113 * [http://pygments.pocoo.org Pygments] for
     114   [wiki:TracSyntaxColoring syntax highlighting].
     115   [http://silvercity.sourceforge.net/ SilverCity] and/or
     116   [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
     117   but are deprecated and you really should be using Pygments.
     118 * [http://pytz.sf.net pytz] to get a complete list of time zones,
     119   otherwise Trac will fall back on a shorter list from
     120   an internal time zone implementation.
     121
     122'''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].
     123
     124Please 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!).
     125
     126
     127== Installing Trac ==
     128=== Using `easy_install`
     129One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
     130With setuptools you can install Trac from the subversion repository;
     131
     132A few examples:
     133
     134 - install Trac 0.12:
     135   {{{
     136   easy_install Trac==0.12
     137   }}}
     138
     139 - install latest development version 0.12dev:
     140   {{{
     141   easy_install Trac==dev
     142   }}}
     143   Note that in this case you won't have the possibility to run a localized version of Trac;
     144   either use a released version or install from source
     145
     146=== Using `pip`
     147'pip' is an easy_install replacement that is very useful to quickly install python packages.
     148To get a trac installation up and running in less than 5 minutes:
     149
     150Assuming you want to have your entire pip installation in /opt/user/trac
     151
     152 -
     153{{{
     154pip -E /opt/user/trac install trac psycopg2
     155}}}
     156or
     157 -
     158{{{
     159pip -E /opt/user/trac install trac mysql-python
     160}}}
     161
     162Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     163
     164pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in /opt/user/trac
     165
     166All commands (tracd, trac-admin) are available in /opt/user/trac/bin . This can also be leveraged for mod_python (using PythonHandler directive) and mod_wsgi (using WSGIDaemonProcess directive)
     167
     168Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     169
     170
     171
     172=== From source
     173Of course, using the python-typical setup at the top of the source directory also works.
     174
     175You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
     176
     177{{{
     178$ python ./setup.py install
     179}}}
     180
     181''You'll need root permissions or equivalent for this step.''
     182
     183This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     184of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     185
     186The 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.
     187
     188If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     189{{{
     190$ python ./setup.py install
     191}}}
     192Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     193
     194=== Advanced Options ===
     195
     196To install Trac to a custom location, or find out about other advanced installation options, run:
     197{{{
     198easy_install --help
     199}}}
     200
     201Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     202
     203Specifically, you might be interested in:
     204{{{
     205easy_install --prefix=/path/to/installdir
     206}}}
     207or, if installing Trac to a Mac OS X system:
     208{{{
     209easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     210}}}
     211Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     212
     213The 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.
     214
     215
     216== Creating a Project Environment ==
     217
     218A [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 [TracIni configuration file], and various other files and directories.
     219
     220A new environment is created using [wiki:TracAdmin trac-admin]:
     221{{{
     222$ trac-admin /path/to/myproject initenv
     223}}}
     224
     225[TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.
     226
     227Using the default database connection string in particular will always work as long as you have SQLite installed.
     228For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     229
     230Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     231
     232Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     233
     234Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter:
     235{{{
     236# chown -R apache.apache /path/to/myproject
     237}}}
     238
     239== Running the Standalone Server ==
     240
     241After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     242{{{
     243$ tracd --port 8000 /path/to/myproject
     244}}}
     245
     246Then, 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:
     247{{{
     248$ tracd -s --port 8000 /path/to/myproject
     249}}}
     250
     251== Running Trac on a Web Server ==
     252
     253Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi.
     254
     255Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     256
     257==== Generating the Trac cgi-bin directory ====
     258
     259In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
     260
     261There 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:
     262{{{
     263mkdir -p /usr/share/trac/projects/my-project
     264trac-admin /usr/share/trac/projects/my-project initenv
     265trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     266mv /tmp/deploy/* /usr/share/trac
     267}}}
     268
     269==== Setting up the Plugin Cache ====
     270
     271Some 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 on how to set environment variables.
     272
     273== Configuring Authentication ==
     274
     275The 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:
     276
     277 * TracStandalone if you use the standalone server, `tracd`.
     278 * TracCgi if you use the CGI or FastCGI web front ends.
     279 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
     280 * TracModPython if you use the Apache mod_python web front end.
     281
     282
     283== Automatic reference to the SVN changesets in Trac tickets ==
     284
     285You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
     286 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     287 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     288
     289This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
     290{{{
     291tracopt.ticket.commit_updater.* = enabled
     292}}}
     293For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
     294
     295== Using Trac ==
     296
     297Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc.
     298
     299Keep 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.
     300
     301'' Enjoy! ''
     302
     303[trac:TracTeam The Trac Team]
     304
     305----
     306See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions