Changes between Initial Version and Version 1 of TracInstall

01/14/11 15:54:51 (12 years ago)



  • TracInstall

    v1 v1  
     1= Trac Installation Guide for 0.12 =  
     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 **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac. 
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N 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 
     16To install Trac, the following software packages must be installed: 
     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 installers or the tar.gz archive for building from source:  
     33$ tar xvfz <version>.tar.gz  
     34$ cd <version>  
     35$ python build_static install  
     38This will extract the SQLite code and build the bindings.  
     40To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build: 
     43$ apt-get install libsqlite3-dev 
     46SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x. 
     48A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 
     49from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 
     50older. See [trac:#9434] for more detail. 
     52See additional information in [trac:PySqlite]. 
     54==== For the PostgreSQL database #ForPostgreSQL 
     56You need to install the database and its Python bindings: 
     57 * [ PostgreSQL] 
     58 * [ psycopg2] 
     60See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 
     63==== For the MySQL database #ForMySQL 
     65Trac can now work quite well with MySQL, provided you follow the guidelines. 
     67 * [ MySQL], version 5.0 or later 
     68 * [ MySQLdb], version 1.2.2 or later 
     70It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database. 
     72=== Optional Dependencies 
     74==== Version Control System ==== 
     76===== Subversion ===== 
     77 * [ 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. 
     79There are [ 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 [ Algazam], which works for me under Python 2.6.) 
     81Note that Trac '''doesn't''' use [ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?] 
     84'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 
     87===== Others ===== 
     89Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersioningSystemBackend]. 
     91==== Web Server ==== 
     92A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. 
     94Alternatively you configure Trac to run in any of the following environments. 
     95 * [ Apache] with  
     96   - [ mod_wsgi], see [wiki:TracModWSGI] and  
     98   - [ mod_python 3.3.1], deprecated: see TracModPython) 
     99 * a [ FastCGI]-capable web server (see TracFastCgi) 
     100 * an [ AJP]-capable web 
     101   server (see [trac:TracOnWindowsIisAjp]) 
     102 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script  
     103   is highly discouraged''', better use one of the previous options.  
     106==== Other Python Packages ==== 
     108 * [ Babel], version >= 0.9.5,  
     109   needed for localization support[[BR]] 
     110   ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.  
     111 * [ docutils], version >= 0.3.9  
     112   for WikiRestructuredText. 
     113 * [ Pygments] for  
     114   [wiki:TracSyntaxColoring syntax highlighting]. 
     115   [ SilverCity] and/or  
     116   [ Enscript] may still be used 
     117   but are deprecated and you really should be using Pygments. 
     118 * [ 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. 
     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] or [trac:IrcChannel]. 
     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!). 
     127== Installing Trac == 
     128=== Using `easy_install` 
     129One way to install Trac is using [ setuptools]. 
     130With setuptools you can install Trac from the subversion repository;  
     132A few examples: 
     134 - install Trac 0.12: 
     135   {{{ 
     136   easy_install Trac==0.12 
     137   }}} 
     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  
     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: 
     150Assuming you want to have your entire pip installation in /opt/user/trac 
     152 -  
     154pip -E /opt/user/trac install trac psycopg2  
     157 -  
     159pip -E /opt/user/trac install trac mysql-python  
     162Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 
     164pip 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  
     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) 
     168Additionally, you can install several trac plugins (listed [ here]) through pip. 
     172=== From source 
     173Of course, using the python-typical setup at the top of the source directory also works. 
     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). 
     178$ python ./ install 
     181''You'll need root permissions or equivalent for this step.'' 
     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. 
     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. 
     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): 
     190$ python ./ install 
     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`). 
     194=== Advanced Options === 
     196To install Trac to a custom location, or find out about other advanced installation options, run: 
     198easy_install --help 
     201Also see [ Installing Python Modules] for detailed information. 
     203Specifically, you might be interested in: 
     205easy_install --prefix=/path/to/installdir 
     207or, if installing Trac to a Mac OS X system: 
     209easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
     211Note: 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 
     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. 
     216== Creating a Project Environment == 
     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. 
     220A new environment is created using [wiki:TracAdmin trac-admin]: 
     222$ trac-admin /path/to/myproject initenv 
     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.  
     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. 
     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. 
     232Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 
     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: 
     236# chown -R apache.apache /path/to/myproject 
     239== Running the Standalone Server == 
     241After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 
     243$ tracd --port 8000 /path/to/myproject 
     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: 
     248$ tracd -s --port 8000 /path/to/myproject 
     251== Running Trac on a Web Server == 
     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. 
     255Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 
     257==== Generating the Trac cgi-bin directory ==== 
     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]. 
     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: 
     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 
     269==== Setting up the Plugin Cache ==== 
     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. 
     273== Configuring Authentication == 
     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: 
     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. 
     283== Automatic reference to the SVN changesets in Trac tickets == 
     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'' 
     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. 
     291tracopt.ticket.commit_updater.* = enabled 
     293For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 
     295== Using Trac == 
     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. 
     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. 
     301'' Enjoy! '' 
     303[trac:TracTeam The Trac Team] 
     306See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions