Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
Apr 22, 2008, 10:09:00 AM (17 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v1 v2  
    22[[TracGuideToc]]
    33
    4 Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and can use [http://sqlite.org/ SQLite] or [http://www.postgresql.org/ PostgreSQL] as  database. For HTML rendering, Trac uses the [http://www.clearsilver.net/ Clearsilver] templating system.
     4Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and needs a database (either [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL] works). For HTML rendering, Trac uses the [http://www.clearsilver.net/ ClearSilver] templating system.
    55
    66What 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 [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms 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.
    … …  
    1111
    1212 * [http://www.python.org/ Python], version >= 2.3.
    13    * Python 2.4 is not supported on Windows since there are no Subversion bindings available for it.
    1413   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
    15  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (>= 1.1 recommended) and corresponding [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]
    16    * Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
    17    * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
     14   * If you want to use Trac with Subversion on Windows, note that there are no precompiled Subversion bindings for Python 2.4, so you probably need Python 2.3.
     15    * 2006-09-20: This seems to be no longer true, see http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91. For subversion 1.4.0 python 2.4 binary bindings are available.
    1816 * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3
    1917   * With python-bindings (`./configure --with-python=/usr/bin/python`)
     18 * You also need a database system and the corresponding python drivers for it.
     19   The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''.
    2020
    2121=== For SQLite ===
    2222
    23  * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.x
    24  * [http://pysqlite.org/ PySQLite]
    25    * version 1.0.x (for SQLite 2.8.x)
    26    * version 1.1.x or 2.x (for SQLite 3.x)
     23 * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.x (preferred)
     24 * [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x). For details see [http://trac.edgewall.org/wiki/PySqlite PySqlite]
     25
     26''Note: Versions of Trac prior to 0.9 do '''not''' work with PySQLite 2.x.''
     27
     28''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.''
     29
     30''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).''
    2731
    2832=== For PostgreSQL ===
    2933
    3034 * [http://www.postgresql.org/ PostgreSQL]
    31  * [http://initd.org/projects/psycopg1 psycopg1], [http://initd.org/projects/psycopg2 psycopg2], or [http://pypgsql.sourceforge.net/ pyPgSQL]
     35 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
     36
     37''Note: PostgreSQL support requires Trac version 0.9 or later.''
     38
     39=== For MySQL ===
     40
     41'''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet.
     42
     43 * [http://mysql.com/ MySQL], version 4.1 or later
     44 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
     45
     46''Note: MySQL support requires Trac version 0.10 or later.''
    3247
    3348=== Optional Requirements ===
    3449
     50==== Version Control System ====
     51 * [http://subversion.tigris.org/ Subversion], version >= 1.0. (either 1.2.3 or >= 1.3.1 recommended) and corresponding [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Python bindings]. For troubleshooting, check [http://projects.edgewall.com/trac/wiki/TracSubversion TracSubversion]
     52   * Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
     53   * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
     54 * Support for other version control systems is provided via third-parties. See [http://projects.edgewall.com/trac/wiki/PluginList PluginList] and [http://projects.edgewall.com/trac/wiki/VersioningSystemBackend VersioningSystemBackend].
     55
     56==== Web Server ====
    3557 * A CGI-capable web server (see TracCgi), or
    3658 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
    3759 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
    38  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.5a13 for using plugins (see TracPlugins)
    39  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 for WikiRestructuredText.
     60    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
     61
     62For those stuck with Apache 1.3, it is also possible to get Trac 0.8.4 working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This hasn't been tested with Trac 0.9, so it may or may not work.
     63
     64==== Other Python Utilities ====
     65 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins)
     66 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
    4067 * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting].
     68    * 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.
    4169
    4270'''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 [http://projects.edgewall.com/trac/wiki/MailingList MailingList] or [http://projects.edgewall.com/trac/wiki/IrcChannel IrcChannel].
    4371
    44 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies.
     72Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular,
     73there are still some pages that are about Trac 0.8).
    4574
    4675== Installing Trac ==
    … …  
    5483
    5584This will byte-compile the python source code and install it in the `site-packages` directory
    56 of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/.`
     85of 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/` (''since [milestone:0.10]'').
    5786
    5887The 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.
    5988
    60 === Advanced Users ===
     89=== Advanced Options ===
    6190
    6291To install Trac to a custom location, or find out about other advanced installation options, run:
    6392{{{
    64 $ python ./setup.py --help
     93$ python ./setup.py install --help
    6594}}}
     95
     96Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
    6697
    6798Specifically, you might be interested in:
    6899{{{
    69 $ python ./setup.py install --prefix=/path/you/want
     100$ python ./setup.py install --prefix=/path/to/installdir
    70101}}}
    71 
    72102
    73103== Creating a Project Environment ==
    … …  
    77107A new environment is created using [wiki:TracAdmin trac-admin]:
    78108{{{
    79 $ trac-admin /path/to/trac_project_env initenv
     109$ trac-admin /path/to/myproject initenv
    80110}}}
    81111
    82 [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the path to an existing subversion 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. The only option where the default value is likely to not work is the path to the Subversion repository, so make sure that one's correct.
     112[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.
    83113
    84114Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    … …  
    92122After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
    93123{{{
    94 $ tracd --port 8000 /path/to/projectenv
     124$ tracd --port 8000 /path/to/myproject
    95125}}}
    96126
    … …  
    104134== Configuring Authentication ==
    105135
    106 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.  To learn about how to accomplish these tasks, please visit one of the following pages:
     136The 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:
    107137
    108138 * TracStandalone if you use the standalone server, `tracd`.
    … …  
    116146Keep 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.
    117147
    118 ''Enjoy!''
     148'' Enjoy! ''
    119149
    120150[http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]