close Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Changes between Initial Version and Version 1 of TracInstall

Dec 15, 2007, 12:51:54 AM (15 years ago)



  • TracInstall

    v1 v1  
     1= Trac Installation Guide for 0.11 =
     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.'''
     6Trac is written in the Python programming language and needs a database, [ SQLite], [ PostgreSQL], or [ MySQL]. For HTML rendering, Trac uses the [ Genshi] templating system.
     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.
     10== Short - Install a released version ==
     11For the quick install, make sure you have [ Python-2.5], [ easy_install] and SQlite-3.3.4 installed (or above).
     13sudo easy_install Pygments
     14sudo easy_install Genshi
     15sudo easy_install Trac
     18== Requirements - also older versions possible ==
     20To install Trac, the following software packages must be installed:
     22 * [ 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 [ 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 * [ setuptools], version >= 0.6
     27 * [ 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: [ ClearSilver]
     32=== For SQLite ===
     34 * [ SQLite], version 3.3.4 and above preferred.
     35 * If not using Python-2.5: [ 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
     37''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the '' script available from the 'contrib' section of the source repository.''
     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}}}". [ 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).''
     41=== For PostgreSQL ===
     43 * [ PostgreSQL]
     44 * [ psycopg2] or [ pyPgSQL]
     46=== For MySQL ===
     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.
     50 * [ MySQL], version 4.1 or later
     51 * [ MySQLdb], version 1.2.1 or later
     53=== Optional Requirements ===
     55==== Version Control System ====
     57'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
     59 * [ 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 [ SWIG] bindings included in the Subversion distribution, '''not''' [ 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 [ pre-compiled bindings] available for win32.
     63 * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend.
     65==== Web Server ====
     66 * A CGI-capable web server (see TracCgi), or
     67 * a [ FastCGI]-capable web server (see TracFastCgi), or
     68 * [ Apache] with [ 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 * [ Apache] with [ 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.
     73For those stuck with Apache 1.3, it is also possible to get Trac working with [ 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.
     75==== Other Python Utilities ====
     76 * [ docutils], version >= 0.3.9 for WikiRestructuredText.
     77 * [ Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [ SilverCity] and/or [ Enscript] may still be used.
     78    * Note that !SilverCity 0.9.6 has a [ bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5.
     79 * [ pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation.
     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.
     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!).
     85== Installing Trac ==
     87Because of setuptools you can do, with the release tag, as well as with trunk:
     92But of course the python-typical setup at the top of the source directory also works:
     94$ python ./ install
     97''Note: you'll need root permissions or equivalent for this step.''
     99This will byte-compile the python source code and install it in the `site-packages` directory
     100of 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/`.
     102The 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.
     104=== Advanced Options ===
     106To install Trac to a custom location, or find out about other advanced installation options, run:
     108easy_install --help
     111Also see [ Installing Python Modules] for detailed information.
     113Specifically, you might be interested in:
     115easy_install --prefix=/path/to/installdir
     118== Creating a Project Environment ==
     120A [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.
     122A new environment is created using [wiki:TracAdmin trac-admin]:
     124$ trac-admin /path/to/myproject initenv
     127[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.
     129Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
     131''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.''
     134== Running the Standalone Server ==
     136After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     138$ tracd --port 8000 /path/to/myproject
     141Then, 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.
     144== Running Trac on a Web Server ==
     146Trac 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.
     148If 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.
     150== Configuring Authentication ==
     152The 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:
     154 * TracStandalone if you use the standalone server, `tracd`.
     155 * TracCgi if you use the CGI or FastCGI methods.
     156 * TracModPython if you use the mod_python method.
     158== Using Trac ==
     160Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
     162Keep 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.
     164'' Enjoy! ''
     166[wiki:TracTeam The Trac Team]
     169See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions