Changes between Version 6 and Version 7 of TracInstall

Timestamp:

Apr 24, 2015, 5:15:04 PM (10 years ago)

Author:

trac

Comment:

--

TracInstall

@@ -1 @@
-{{{#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
-
- '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\
- For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)''' 
-}}}
-
 = Trac Installation Guide for 1.0
 [[TracGuideToc]]
@@ -10 +4 @@
 Trac 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.
 
-Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version, as usual.
-
-If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
-
-What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac: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.
+Since version 0.12, Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
+
+If you're interested in contributing new translations for other languages or enhancing the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N].
+
+What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please '''first read through these general instructions''' to get a good understanding of the tasks involved.
 
 [[PageOutline(2-3,Installation Steps,inline)]]
@@ -24 +18 @@
  * [http://www.python.org/ Python], version >= 2.5 and < 3.0
    (note that we dropped the support for Python 2.4 in this release)
- * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
+ * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
 
-You also need a database system and the corresponding python bindings.
-The database can be either SQLite, PostgreSQL or MySQL.
+You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
 
 ==== For the SQLite database #ForSQLite
 
-As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
-
-However, if you'd like, you can download the latest and greatest version of [[trac:PySqlite]] from 
-[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows
-installers or the `tar.gz` archive for building from source: 
-{{{#!sh
-$ tar xvfz <version>.tar.gz 
-$ cd <version> 
-$ python setup.py build_static install 
-}}}
- 
-This will download the latest SQLite code and build the bindings. 
-
-SQLite 2.x is no longer supported.
-
-A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases
-from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
-older. See #9434 for more detail.
-
-See additional information in [trac:PySqlite PySqlite].
+As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python: the `sqlite3` module.
+
+Optionally, you may install a newer version of [pypi:pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
 
 ==== For the PostgreSQL database #ForPostgreSQL
@@ -61 +37 @@
 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
 
-
 ==== For the MySQL database #ForMySQL
 
-Trac can now work quite well with MySQL, provided you follow the guidelines.
+Trac works well with MySQL, provided you follow the guidelines:
 
  * [http://mysql.com/ MySQL], version 5.0 or later
  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
 
-It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database.
+Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
 
 === Optional Dependencies
@@ -76 +51 @@
 
 ===== Subversion
- * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
-
-There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.)
+ * [http://subversion.apache.org/ Subversion], 1.5.x or later and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. may still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page.
+
+There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.)
 
 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 
 
-
 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].
 
+===== Git
+ * [http://git-scm.com/ Git] 1.5.6 or later.
+
+More information is available on the [trac:TracGit] page.
 
 ===== Others 
 
-Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem].
+Support for other version control systems is provided via third-parties. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].
 
 ==== Web Server
 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
 
-Alternatively you can configure Trac to run in any of the following environments.
+Alternatively you can configure Trac to run in any of the following environments:
  * [http://httpd.apache.org/ Apache] with 
    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 
      http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac
-   - [http://modpython.org/ mod_python 3.3.1], (deprecated: see TracModPython)
+   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
+ * a FastCGI and FastCGI-to-WSGI gateway (see [trac:TracOnWindowsIisWfastcgi])
  * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 
    is highly discouraged''', better use one of the previous options. 
@@ -107 +86 @@
 ==== Other Python Packages
 
- * [http://babel.edgewall.org Babel], version >= 0.9.5, 
-   needed for localization support (unreleased version 1.0dev should work as well)
+ * [http://babel.edgewall.org Babel], version 0.9.5, 0.9.6 or >= 1.3
+   needed for localization support
  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 
    for WikiRestructuredText.
  * [http://pygments.org Pygments] for 
-   [wiki:TracSyntaxColoring syntax highlighting].
+   [TracSyntaxColoring syntax highlighting].
    [http://silvercity.sourceforge.net/ SilverCity] and/or 
    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used
@@ -120 +99 @@
    an internal time zone implementation.
 
-'''Attention''': The various available versions of these dependencies are not necessarily interchangeable, 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 [trac:MailingList] or [trac:IrcChannel].
-
-Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac: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!).
-
+{{{#!div style="border: 1pt dotted; margin: 1em"
+**Attention**: The available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers. If you are having trouble getting Trac to work, please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
+}}}
+
+Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac: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''.
 
 == Installing Trac
+
+The [TracAdmin trac-admin] command-line tool, used to create and maintain [TracEnvironment project environments], as well as the [TracStandalone tracd] standalone server are installed along with Trac. There are several methods for installing Trac.
+
 === Using `easy_install`
-One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools].
-With setuptools you can install Trac from the Subversion repository; 
+Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
 
 A few examples:
@@ -143 +125 @@
    either use a released version or install from source 
 
+More information can be found on the [trac:setuptools] page.
+
 {{{#!div style="border: 1pt dotted; margin: 1em"
 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in the sections on [#RunningtheStandaloneServer Running The Standalone Server] and [#RunningTraconaWebServer Running Trac on a Web Server]. 
@@ -165 +149 @@
 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
 
-pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`.
+pip will automatically resolve all dependencies (like Genshi, pygments, etc.), download the latest packages from pypi.python.org and create a self contained installation in `/opt/user/trac`.
 
 All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive)
 
-Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
-
-
+Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.
 
 === From source
-Of course, using the python-typical setup at the top of the source directory also works.
-
-You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`), or you can get the source directly from the repository (see [trac:SubversionRepository] for details).
+Using the python-typical setup at the top of the source directory also works. You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`) from the [trac:TracDownload] page, or you can get the source directly from the repository. See [trac:TracRepositories#OfficialSubversionrepository TracRepositories] for details.
 
 {{{#!sh
@@ -182 +162 @@
 }}}
 
-''You'll need root permissions or equivalent for this step.''
+''You will need root permissions or equivalent for this step.''
 
 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
 
-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.
-
 If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
 {{{#!sh
@@ -195 +173 @@
 Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
 
-=== Advanced Options
+=== Using installer
+
+On Windows Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32 and 64 bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.
+
+=== Using package manager
+
+Trac may be available in the package repository for your platform. Note however, that the version provided by the package manager may not be the latest release.
+
+=== Advanced `easy_install` Options
 
 To install Trac to a custom location, or find out about other advanced installation options, run:
@@ -212 +198 @@
 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
 }}}
-Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default.
+Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.5/site-packages }}} by default.
 
 The 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.
 
-
 == Creating a Project Environment
 
-A [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 [TracIni configuration file], and various other files and directories.
-
-A new environment is created using [wiki:TracAdmin trac-admin]:
+A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and other files and directories.
+
+A new environment is created using [TracAdmin trac-admin]:
 {{{#!sh
 $ trac-admin /path/to/myproject initenv
@@ -229 +214 @@
 
 Using the default database connection string in particular will always work as long as you have SQLite installed.
-For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
+For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
 
 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, and support for specific version control systems is disabled by default.
@@ -235 +220 @@
 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
 
-When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2 (though the best advice is to opt for a platform with sub-second timestamp resolution when possible regardless of the version of Trac you are running).
+{{{#!div style="border: 1pt dotted; margin: 1em"
+**Filesystem Warning:** When selecting the location of your environment, make sure that the filesystem on which the environment directory resides supports sub-second timestamps (i.e. **not** `ext2` or `ext3` on Linux), as the modification time of the `conf/trac.ini` file will be monitored to decide whether an environment restart is needed or not. A too coarse-grained timestamp resolution may result in inconsistencies in Trac < 1.0.2. The best advice is to opt for a platform with sub-second timestamp resolution, regardless of the Trac version.
+}}}
 
 Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter:
@@ -248 +235 @@
 }}}
 
-
 == Deploying Trac
 
 === Running the Standalone Server
 
-After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
+After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:
 {{{#!sh
 $ tracd --port 8000 /path/to/myproject
@@ -280 +266 @@
 
 Trac provides various options for connecting to a "real" web server: 
- - [wiki:TracFastCgi FastCGI]
+ - [TracFastCgi FastCGI]
  - [wiki:TracModWSGI mod_wsgi] 
- - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)//
- - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)//
+ - [TracModPython mod_python]
+ - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
 
 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
@@ -289 +275 @@
 ==== Generating the Trac cgi-bin directory #cgi-bin
 
-In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin].
-
-There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
+In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [TracAdmin trac-admin].
+
+There is, however, a bit of a chicken-and-egg problem. The [TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
 {{{#!sh
 mkdir -p /usr/share/trac/projects/my-project
@@ -300 +286 @@
 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
 
-
 ==== Mapping Static Resources
 
@@ -321 +306 @@
 Assuming the deployment has been done this way:
 {{{#!sh
-$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common
+$ trac-admin /var/trac/env deploy /path/to/shared/trac
 }}}
 
@@ -354 +339 @@
 }}}
 
-Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting:
+Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
 {{{#!ini
 [trac]
@@ -365 +350 @@
 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common
 }}}
-
 
 ==== Setting up the Plugin Cache
@@ -382 +366 @@
  * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)
 
-The following document also constains some useful information for beginners: [trac:TracAuthenticationIntroduction].
+The following document also contains some useful information for beginners: [trac:TracAuthenticationIntroduction].
 
 == Granting admin rights to the admin user
@@ -397 +381 @@
 Support for version control systems is provided by optional components in Trac and the components are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. See TracRepositoryAdmin for more details.
 
-The components can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
+The version control systems are enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
 
 {{{#!ini
@@ -407 +391 @@
 }}}
 
-After enabling the components, repositories can be configured through the "Repositories" admin panel or by editing [TracIni#repositories-section trac.ini].
-
-=== Automatic reference to the SVN changesets in Trac tickets
-
-You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas:
- * '''`Refs #123`''' - to reference this changeset in `#123` ticket
- * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
-
-This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel.
-{{{#!ini
-tracopt.ticket.commit_updater.* = enabled
-}}}
-For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.
+After enabling the components, repositories can be configured through the //Repositories// admin panel or by editing [TracIni#repositories-section trac.ini]. Automatic changeset references can be inserted as ticket comments by configuring [TracRepositoryAdmin#Automaticchangesetreferencesintickets CommitTicketUpdater].
 
 === Using Trac
@@ -425 +397 @@
 Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc.
 
-Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.
+Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [TracPermissions permissions] to authenticated users to see the full set of features.
 
 '' Enjoy! ''