Wiki

Changes between Initial Version and Version 1 of TracInstall

Show
Ignore:
Timestamp:
02/23/08 22:54:25 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v1  
     1= Trac Installation Guide for 0.11 =  
     2[[TracGuideToc]] 
     3 
     4  '''NOTE: this page is now for 0.11, which will be released soon. For installing previous Trac versions, please refer to wiki:0.10/TracInstall.''' 
     5 
     6Trac 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. 
     7 
     8What 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. 
     9 
     10== Short - Install a released version == 
     11For 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). 
     12{{{ 
     13sudo easy_install Pygments 
     14sudo easy_install Genshi 
     15sudo easy_install Trac 
     16}}} 
     17 
     18== Requirements - also older versions possible == 
     19 
     20To install Trac, the following software packages must be installed: 
     21 
     22 * [http://www.python.org/ Python], version >= 2.3 
     23   * 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). 
     24   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 
     25   * See instructions in ["TracOnWindows/Python2.5"] 
     26 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
     27 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.3.6 
     28 * You also need a database system and the corresponding python drivers for it. 
     29   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
     30 * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
     31 
     32=== For SQLite === 
     33 
     34 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred. 
     35 * 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 PySqlite 
     36 
     37''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.'' 
     38 
     39''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).'' 
     40 
     41=== For PostgreSQL === 
     42 
     43 * [http://www.postgresql.org/ PostgreSQL] 
     44 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] 
     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 MySqlDb for more detailed informations. 
     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 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 PluginList and 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 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
     69    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
     70 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI]) 
     71    * While mod_wsgi is very new and somewhat experimental, this should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. 
     72 
     73For 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. 
     74 
     75==== Other Python Utilities ==== 
     76 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
     77 * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used. 
     78    * Note that !SilverCity 0.9.6 has a [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5. 
     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 MailingList or IrcChannel. 
     82 
     83Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [wiki: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!). 
     84 
     85== Installing Trac == 
     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.com/repos/trac/tags/trac-0.11 
     92}}} 
     93 
     94But of course the python-typical setup at the top of the source directory also works: 
     95{{{ 
     96$ python ./setup.py install 
     97}}} 
     98 
     99''Note: you'll need root permissions or equivalent for this step.'' 
     100 
     101This will byte-compile the python source code and install it in the `site-packages` directory 
     102of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/`. `conf` and `plugins` stub directories are also created under `$prefix/share/trac/`. 
     103On Linux, the default value of `$prefix` is `/usr`, so the installation will be to `/usr/share/trac`, whereas the BSDs use `/usr/local`. Other Unix or Unix-like systems might use a similar prefix or something like `/opt`, please see your system's documentation for details. 
     104 
     105The 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. 
     106 
     107=== Advanced Options === 
     108 
     109To install Trac to a custom location, or find out about other advanced installation options, run: 
     110{{{ 
     111easy_install --help 
     112}}} 
     113 
     114Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 
     115 
     116Specifically, you might be interested in: 
     117{{{ 
     118easy_install --prefix=/path/to/installdir 
     119}}} 
     120 
     121== Creating a Project Environment == 
     122 
     123A [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. 
     124 
     125A new environment is created using [wiki:TracAdmin trac-admin]: 
     126{{{ 
     127$ trac-admin /path/to/myproject initenv 
     128}}} 
     129 
     130[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. 
     131 
     132Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
     133 
     134''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:'' 
     135 
     136  chown -R apache.apache /path/to/myproject 
     137 
     138 
     139== Running the Standalone Server == 
     140 
     141After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 
     142{{{ 
     143$ tracd --port 8000 /path/to/myproject 
     144}}} 
     145 
     146Then, 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. 
     147 
     148 
     149== Running Trac on a Web Server == 
     150 
     151Trac 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. 
     152 
     153If you're not afraid of running development code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module is not considered stable just yet. 
     154 
     155== Configuring Authentication == 
     156 
     157The 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: 
     158 
     159 * TracStandalone if you use the standalone server, `tracd`. 
     160 * TracCgi if you use the CGI or FastCGI methods. 
     161 * TracModPython if you use the mod_python method. 
     162 
     163== Using Trac == 
     164 
     165Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. 
     166 
     167Keep 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. 
     168 
     169'' Enjoy! '' 
     170 
     171[wiki:TracTeam The Trac Team] 
     172 
     173---- 
     174See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions