Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
01/22/09 18:48:35 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    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 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 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. 
    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. 
     6What 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. 
    77 
    8 == Requirements == 
     8== Short - Install a released version == 
     9For 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). 
     10{{{ 
     11sudo easy_install Trac==0.11 
     12}}} 
     13 
     14== Requirements - also older versions possible == 
    915 
    1016To install Trac, the following software packages must be installed: 
    1117 
    12  * [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. 
     18 * [http://www.python.org/ Python], version >= 2.3 
     19   * 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). 
    1420   * 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`. 
    18  * [http://www.clearsilver.net/ ClearSilver], version >= 0.9.3 
    19    * With python-bindings (`./configure --with-python=/usr/bin/python`) 
     21   * See instructions in ["TracOnWindows/Python2.5"] 
     22 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
     23 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1 
     24 * You also need a database system and the corresponding python drivers for it. 
     25   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
     26 * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
    2027 
    2128=== For SQLite === 
    2229 
    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) 
     30 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred. 
     31 * 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 
     32 
     33''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.'' 
     34 
     35''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).'' 
    2736 
    2837=== For PostgreSQL === 
    2938 
    3039 * [http://www.postgresql.org/ PostgreSQL] 
    31  * [http://initd.org/projects/psycopg1 psycopg1], [http://initd.org/projects/psycopg2 psycopg2], or [http://pypgsql.sourceforge.net/ pyPgSQL] 
     40 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] 
     41 
     42'''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. 
     43 
     44=== For MySQL === 
     45 
     46'''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. 
     47 
     48 * [http://mysql.com/ MySQL], version 4.1 or later 
     49 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
    3250 
    3351=== Optional Requirements === 
    3452 
     53==== Version Control System ==== 
     54 
     55'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. 
     56 
     57 * [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 
     58   * 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). 
     59   * 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`. 
     60   * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.  
     61 * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend. 
     62 
     63==== Web Server ==== 
    3564 * A CGI-capable web server (see TracCgi), or 
    3665 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 
     66 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI]) 
     67    * 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. 
    3768 * [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. 
    40  * [http://silvercity.sourceforge.net/ SilverCity] and/or [http://www.gnu.org/software/enscript/enscript.html Enscript] for [wiki:TracSyntaxColoring syntax highlighting]. 
     69    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
    4170 
    42 '''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]. 
     71For 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. 
    4372 
    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. 
     73==== Other Python Utilities ==== 
     74 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
     75 * [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. 
     76    * 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. 
     77 * [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. 
     78 
     79'''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. 
     80 
     81Please 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!). 
    4582 
    4683== Installing Trac == 
    4784 
    48 Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory: 
     85One way to install Trac is using `setuptools`. 
     86With setuptools you can install Trac from the subversion repository; for example, 
     87to install release version 0.11b2 do: 
     88{{{ 
     89easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2 
     90}}} 
     91 
     92But of course the python-typical setup at the top of the source directory also works: 
    4993{{{ 
    5094$ python ./setup.py install 
     
    5397''Note: you'll need root permissions or equivalent for this step.'' 
    5498 
    55 This 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/.` 
     99This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     100of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 
    57101 
    58102The 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. 
    59103 
    60 === Advanced Users === 
     104=== Advanced Options === 
    61105 
    62106To install Trac to a custom location, or find out about other advanced installation options, run: 
    63107{{{ 
    64 $ python ./setup.py --help 
     108easy_install --help 
    65109}}} 
     110 
     111Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 
    66112 
    67113Specifically, you might be interested in: 
    68114{{{ 
    69 $ python ./setup.py install --prefix=/path/you/want 
     115easy_install --prefix=/path/to/installdir 
     116}}} 
     117or, if installing Trac to a Mac OS X system: 
     118{{{ 
     119easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
    70120}}} 
    71121 
     122The 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. 
    72123 
    73124== Creating a Project Environment == 
     
    77128A new environment is created using [wiki:TracAdmin trac-admin]: 
    78129{{{ 
    79 $ trac-admin /path/to/trac_project_env initenv 
     130$ trac-admin /path/to/myproject initenv 
    80131}}} 
    81132 
    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. 
     133[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. 
    83134 
    84135Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
    85136 
    86 ''Note: The user account under which the web server runs will require write permissions to the environment 
    87 directory and all the files inside.'' 
     137''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:'' 
     138 
     139  chown -R apache.apache /path/to/myproject 
    88140 
    89141 
     
    92144After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 
    93145{{{ 
    94 $ tracd --port 8000 /path/to/projectenv 
     146$ tracd --port 8000 /path/to/myproject 
    95147}}} 
    96148 
    97 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. 
     149Then, 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: 
     150{{{ 
     151$ tracd -s --port 8000 /path/to/myproject 
     152}}} 
    98153 
    99154 
    100155== Running Trac on a Web Server == 
    101156 
    102 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. 
     157Trac 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. 
     158 
     159If 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. 
    103160 
    104161== Configuring Authentication == 
    105162 
    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: 
     163The 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: 
    107164 
    108165 * TracStandalone if you use the standalone server, `tracd`. 
    109166 * TracCgi if you use the CGI or FastCGI methods. 
    110167 * TracModPython if you use the mod_python method. 
     168 
     169== Trac 0.11 & SVN on Mac OS X Leopard (10.5) == 
     170 
     171 * TracOnLeopardServer 
    111172 
    112173== Using Trac == 
     
    116177Keep 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. 
    117178 
    118 ''Enjoy!'' 
     179'' Enjoy! '' 
    119180 
    120 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team] 
     181[wiki:TracTeam The Trac Team] 
    121182 
    122183---- 
    123 See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions 
     184See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
     185