Changes between Version 3 and Version 4 of TracInstall

01/28/11 14:52:13 (5 years ago)



  • TracInstall

    v3 v4  
    1 = Trac Installation Guide =
     1= Trac Installation Guide for 0.12 =
    4 The Trac web-based project management tool is implemented as a CGI- or standalone program. Trac is written in the [ Python] programming language
    5 and uses the [ SQLite] embedded database for persistant storage. For HTML rendering, Trac uses the [ Clearsilver] template system.
    8 == Requirements ==
     4Trac is written in the Python programming language and needs a database, [ SQLite], [ PostgreSQL], or [ MySQL]. For HTML rendering, Trac uses the [ Genshi] templating system.
     6Since 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.
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
     10What 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.
     12[[PageOutline(2-3,Installation Steps,inline)]]
     14== Dependencies ==
     15=== Mandatory Dependencies
    1016To 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)
     18 * [ Python], version >= 2.4 and < 3.0
     19   (note that we dropped the support for Python 2.3 in this release)
     20 * [ setuptools], version >= 0.6
     21 * [ Genshi], version >= 0.6
     23You also need a database system and the corresponding python bindings.
     24The database can be either SQLite, PostgreSQL or MySQL.
     26==== For the SQLite database #ForSQLite
     28If you're using Python 2.5 or 2.6, you already have everything you need.
     30If you're using Python 2.4 and need pysqlite, you can download from
     31[ google code] the Windows
     32installers or the tar.gz archive for building from source:
     34$ tar xvfz <version>.tar.gz
     35$ cd <version>
     36$ python build_static install
     39This will extract the SQLite code and build the bindings.
     41SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x
     42bindings are also no longer supported, use pysqlite 2.x.
     44See additional information in [trac:PySqlite PySqlite].
     46==== For the PostgreSQL database #ForPostgreSQL
     48You need to install the database and its Python bindings:
     49 * [ PostgreSQL]
     50 * [ psycopg2]
     52See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     55==== For the MySQL database #ForMySQL
     57Trac can now work quite well with MySQL, provided you follow the guidelines.
     59 * [ MySQL], version 5.0 or later
     60 * [ MySQLdb], version 1.2.2 or later
     62It is '''very''' important to read carefully the  [trac:MySqlDb MySqlDb] page before creating the database.
     64=== Optional Dependencies
     66==== Version Control System ====
     68===== Subversion =====
     69 * [ 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.
     71There are [ pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [ PySVN], neither does it work yet with the newer `ctype`-style bindings
     74'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
     77===== Others =====
     79Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].
     81==== Web Server ====
     82A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.
     84Alternatively you configure Trac to run in any of the following environments.
     85 * [ Apache] with
     86   - [ mod_wsgi], see [wiki:TracModWSGI] and
     88   - [ mod_python 3.3.1], see TracModPython)
     89 * a [ FastCGI]-capable web server (see TracFastCgi)
     90 * an [ AJP]-capable web
     91   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     92 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
     93   is highly discouraged''', better use one of the previous options.
     96==== Other Python Packages ====
     98 * [ Babel], version >= 0.9.5,
     99   needed for localization support
     100 * [ docutils], version >= 0.3.9
     101   for WikiRestructuredText.
     102 * [ Pygments] for
     103   [wiki:TracSyntaxColoring syntax highlighting].
     104   [ SilverCity] and/or
     105   [ Enscript] may still be used
     106   but are deprecated and you really should be using Pygments.
     107 * [ pytz] to get a complete list of time zones,
     108   otherwise Trac will fall back on a shorter list from
     109   an internal time zone implementation.
     111'''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].
     113Please 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!).
    26116== Installing Trac ==
    27 Like most Python programs, install the Trac python modules by running the following command at the top of the source directory:
     117=== Using `easy_install`
     118One way to install Trac is using `setuptools`.
     119With setuptools you can install Trac from the subversion repository;
     121A few examples:
     123 - install Trac 0.12:
     124   {{{
     125   easy_install Trac==0.12
     126   }}}
     128 - install latest development version 0.12dev:
     129   {{{
     130   easy_install Trac==dev
     131   }}}
     132   Note that in this case you won't have the possibility to run a localized version of Trac;
     133   either use a released version or install from source
     135=== Using `pip`
     136'pip' is an easy_install replacement that is very useful to quickly install python packages.
     137To get a trac installation up and running in less than 5 minutes:
     139Assuming you want to have your entire pip installation in /opt/user/trac
     141 -
     143pip -E /opt/user/trac install trac psycopg2
     146 -
     148pip -E /opt/user/trac install trac mysql-python
     151Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     153pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on and create a self contained installation in /opt/user/trac
     155All 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)
     157Additionally, you can install several trac plugins (listed [ here]) through pip.
     161=== From source
     162Of course, using the python-typical setup at the top of the source directory also works.
     164You 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).
    29167$ python ./ install
    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/ .
    35 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments].
    37 The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac.
    39 '''Note:''' you'll need root permissions or equivalent for this step.
    41 For more information on installing Trac on specific platforms, see the [ TracInstallPlatforms] page (on the main project web site).
    43 === Advanced Users ===
    44 To install Trac in a custom location, and view other advanced install options, run:
    45 {{{
    46 $ python ./ --help
    47 }}}
     170''You'll need root permissions or equivalent for this step.''
     172This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
     173of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     175The 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.
     177If 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):
     179$ python ./ install
     181Alternatively, 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`).
     183=== Advanced Options ===
     185To install Trac to a custom location, or find out about other advanced installation options, run:
     187easy_install --help
     190Also see [ Installing Python Modules] for detailed information.
     192Specifically, you might be interested in:
     194easy_install --prefix=/path/to/installdir
     196or, if installing Trac to a Mac OS X system:
     198easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
     200Note: If installing on Mac OS X 10.6 running {{{ easy_install }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     202The 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.
    49205== Creating a Project Environment ==
    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.
    56 A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
    58 {{{
    59 $ trac-admin /path/to/projectenv initenv
    60 }}}
    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).
    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.''
    68 The same applies for the subversion repository files (unless using the [ FSFS Subversion backend], something we highly recommend.
    70 == Configuring Apache ==
    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.
    74 Edit the apache config and add this snippet, filenames edited to match your installation:
    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>
    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>
    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 }}}
    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).
     207A [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.
     209A new environment is created using [wiki:TracAdmin trac-admin]:
     211$ trac-admin /path/to/myproject initenv
     214[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.
     216Using the default database connection string in particular will always work as long as you have SQLite installed.
     217For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
     219Since 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.
     221Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
     223Finally, 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:
     225# chown -R apache.apache /path/to/myproject
     228== Running the Standalone Server ==
     230After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     232$ tracd --port 8000 /path/to/myproject
     235Then, 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:
     237$ tracd -s --port 8000 /path/to/myproject
     240== Running Trac on a Web Server ==
     242Trac 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.
     244Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
     246==== Generating the Trac cgi-bin directory ====
     248In 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].
     250There 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:
     252mkdir -p /usr/share/trac/projects/my-project
     253trac-admin /usr/share/trac/projects/my-project initenv
     254trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
     255mv /tmp/deploy/* /usr/share/trac
     258==== Setting up the Plugin Cache ====
     260Some 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.
     262== Configuring Authentication ==
     264The 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:
     266 * TracStandalone if you use the standalone server, `tracd`.
     267 * TracCgi if you use the CGI or FastCGI web front ends.
     268 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.
     269 * TracModPython if you use the Apache mod_python web front end.
     272== Automatic reference to the SVN changesets in Trac tickets ==
     274You 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:
     275 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     276 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     278This 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.
     280tracopt.ticket.commit_updater.* = enabled
     282For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
    110284== Using Trac ==
    112 '''Congratulations!''' You should now have a running Trac installation at:
    114 http://<yourhostname>/cgi-bin/trac.cgi
    116 You should be able to browse your subversion repository, create tickets,
    117 view the timeline and use all the features of Trac.
    119 Keep 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).
    123 Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    125 For user documentation, see TracGuide.
    127 ''Enjoy!''
    129 [ The Trac Team]
     286Once 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.
     288Keep 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.
     290'' Enjoy! ''
     292[trac:TracTeam The Trac Team]
    132 See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython
     295See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions
Back to Top