Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
05/01/08 15:00:58 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    1 = Trac Installation Guide =  
     1= Trac Installation Guide for 0.11 =  
    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 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. 
     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.''' 
    55 
    6 What 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. 
     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. 
    77 
    8 == Requirements == 
     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 Trac==0.11b2 
     14}}} 
     15 
     16== Requirements - also older versions possible == 
    917 
    1018To install Trac, the following software packages must be installed: 
    1119 
    12  * [http://www.python.org/ Python], version >= 2.3. 
     20 * [http://www.python.org/ Python], version >= 2.3 
     21   * 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). 
    1322   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 
    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. 
    16  * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3 
    17    * With python-bindings (`./configure --with-python=/usr/bin/python`) 
     23   * See instructions in ["TracOnWindows/Python2.5"] 
     24 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
     25 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1 
    1826 * You also need a database system and the corresponding python drivers for it. 
    19    The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''. 
     27   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
     28 * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
    2029 
    2130=== For SQLite === 
    2231 
    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.'' 
     32 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred. 
     33 * 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 
    2734 
    2835''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.'' 
     
    3542 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] 
    3643 
    37 ''Note: PostgreSQL support requires Trac version 0.9 or later.'' 
     44'''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later. 
    3845 
    3946=== For MySQL === 
    4047 
    41 '''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet. 
     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 information. 
    4249 
    4350 * [http://mysql.com/ MySQL], version 4.1 or later 
    4451 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
    4552 
    46 ''Note: MySQL support requires Trac version 0.10 or later.'' 
    47  
    4853=== Optional Requirements === 
    4954 
    5055==== 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]. 
     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. 
    5564 
    5665==== Web Server ==== 
    5766 * A CGI-capable web server (see TracCgi), or 
    5867 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 
     68 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI]) 
     69    * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python. 
    5970 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
    6071    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
    6172 
    62 For 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. 
     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. 
    6374 
    6475==== Other Python Utilities ==== 
    65  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 for using plugins (see TracPlugins) 
    6676 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
    67  * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting]. 
     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. 
    6878    * 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. 
    6980 
    70 '''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]. 
     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. 
    7182 
    72 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. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular,  
    73 there are still some pages that are about Trac 0.8). 
     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!). 
    7484 
    7585== Installing Trac == 
    7686 
    77 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory: 
     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.11b2 do: 
     90{{{ 
     91easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2 
     92}}} 
     93 
     94But of course the python-typical setup at the top of the source directory also works: 
    7895{{{ 
    7996$ python ./setup.py install 
     
    8299''Note: you'll need root permissions or equivalent for this step.'' 
    83100 
    84 This will byte-compile the python source code and install it in the `site-packages` directory 
    85 of 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]''). 
     101This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     102of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 
    86103 
    87104The 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. 
     
    91108To install Trac to a custom location, or find out about other advanced installation options, run: 
    92109{{{ 
    93 $ python ./setup.py install --help 
     110easy_install --help 
    94111}}} 
    95112 
     
    98115Specifically, you might be interested in: 
    99116{{{ 
    100 $ python ./setup.py install --prefix=/path/to/installdir 
     117easy_install --prefix=/path/to/installdir 
    101118}}} 
     119or, if installing Trac to a Mac OS X system: 
     120{{{ 
     121easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
     122}}} 
     123 
     124The 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. 
    102125 
    103126== Creating a Project Environment == 
     
    114137Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
    115138 
    116 ''Note: The user account under which the web server runs will require write permissions to the environment 
    117 directory and all the files inside.'' 
     139''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:'' 
     140 
     141  chown -R apache.apache /path/to/myproject 
    118142 
    119143 
     
    125149}}} 
    126150 
    127 Then, 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. 
     151Then, 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: 
     152{{{ 
     153$ tracd -s --port 8000 /path/to/myproject 
     154}}} 
    128155 
    129156 
    130157== Running Trac on a Web Server == 
    131158 
    132 Trac 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. 
     159Trac 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. 
     160 
     161If 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. 
    133162 
    134163== Configuring Authentication == 
     
    140169 * TracModPython if you use the mod_python method. 
    141170 
     171== Trac 0.11 & SVN on Mac OS X Leopard (10.5) == 
     172 
     173 * TracOnLeopardServer 
     174 
    142175== Using Trac == 
    143176 
     
    148181'' Enjoy! '' 
    149182 
    150 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team] 
     183[wiki:TracTeam The Trac Team] 
    151184 
    152185---- 
    153 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions 
     186See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
     187