Changes between Version 5 and Version 6 of TracInstall

Timestamp:

Nov 4, 2008, 9:55:04 PM (16 years ago)

Author:

trac

Comment:

—

TracInstall

@@ -9 +9 @@
 For 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).
 {{{
-sudo easy_install Trac==0.11
+sudo easy_install Trac
 }}}
 
-== Requirements - also older versions possible ==
+== Requirements ==
+The hardware requirements for running Trac obviously depend on the expected data volume (number of wiki pages, tickets, revisions) and traffic. Very small projects will run fine with a 500MHz processor and 128MB RAM using SQLite. In general, the more RAM, the better. A fast hard disk also helps.
 
 To install Trac, the following software packages must be installed:
@@ -21 +22 @@
    * See instructions in ["TracOnWindows/Python2.5"]
  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
- * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1
+ * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.5 (was version >= 0.4.1 on previous 0.11 release candidates)
  * You also need a database system and the corresponding python drivers for it.
    The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
- * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
+ * Optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
 
-=== For SQLite ===
+==== For SQLite ====
 
- * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred.
+ * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred (note: it is preinstalled in Python 2.5.2).
  * 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
 
@@ -35 +36 @@
 ''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).''
 
-=== For PostgreSQL ===
+==== For PostgreSQL ====
 
  * [http://www.postgresql.org/ PostgreSQL]
- * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
+ * [http://initd.org/projects/psycopg2 psycopg2]
+ * See [wiki:DatabaseBackend#Postgresql]
 
 '''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.
 
-=== For MySQL ===
+==== For MySQL ====
 
 '''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.
@@ -49 +51 @@
  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
 
-=== Optional Requirements ===
+== Optional Requirements ==
 
 ==== Version Control System ====
@@ -64 +66 @@
  * A CGI-capable web server (see TracCgi), or
  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
- * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI])
+ * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see Trac:TracOnWindowsIisAjp), or
+ * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI] or http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac)
     * 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.
  * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
@@ -73 +76 @@
 ==== Other Python Utilities ====
  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
- * [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.
-    * 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.
+ * [http://pygments.pocoo.org Pygments] for '''syntax highlighting''', although [http://silvercity.sourceforge.net/ SilverCity] >= 0.9.7 and/or [http://gnu.org/software/enscript/enscript.html GNU Enscript] are also possible. Refer to TracSyntaxColoring for details.
  * [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.
 
@@ -85 +87 @@
 One way to install Trac is using `setuptools`.
 With setuptools you can install Trac from the subversion repository; for example,
-to install release version 0.11b2 do:
+to install release version 0.11 do:
 {{{
-easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2
+easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11
 }}}
 
@@ -102 +104 @@
 The 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.
 
-=== Advanced Options ===
+==== Advanced Options ====
 
 To install Trac to a custom location, or find out about other advanced installation options, run:
@@ -139 +141 @@
   chown -R apache.apache /path/to/myproject
 
+'''Warning: If the trac.cgi files are not installed where you expect, then the current documentation is insufficient; it might be necessary to use the 'deploy' command in trac-admin.  See tickets http://trac.edgewall.org/ticket/7312 and possibly http://trac.edgewall.org/ticket/6827'''
 
 == Running the Standalone Server ==
@@ -157 +160 @@
 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.
 
-If 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.
+If you're not afraid of running newer code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module isn't as extensively tested as mod_python.
+
+Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.
+
+==== Setting up the Plugin Cache ====
+
+Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHE environment variable. Refer to your server documentation for detailed instructions.
 
 == Configuring Authentication ==