Changes between Version 5 and Version 6 of TracInstall
- Timestamp:
- May 6, 2010, 11:40:13 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v5 v6 1 {{{ 2 #!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc;" 3 4 '''NOTE: this page is for 0.12dev (trunk), the version currently in development. For installing previous Trac versions, please refer to [[0.11/TracInstall]]''' 5 }}} 1 6 = Trac Installation Guide for 0.12dev = 2 {{{3 #!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc;"4 5 '''NOTE: this page is for 0.12dev (trunk), the version currently in development. For installing previous Trac versions, please refer to TracInstall (0.11)'''6 }}}7 7 [[TracGuideToc]] 8 8 9 9 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. 10 10 11 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. Note Trac can still be installed without Babel, but thenyou will only get the default english version, as usual.11 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. 12 12 13 13 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at ["TracL10N"]. … … 15 15 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 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. 16 16 17 18 == Prerequisites == 19 17 [[PageOutline(2-3,Installation Steps,inline)]] 18 19 == Dependencies == 20 === Mandatory Dependencies 20 21 To install Trac, the following software packages must be installed: 21 22 22 * [http://www.python.org/ Python], version >= 2.4 (we dropped the support for Python 2.3 in this release) 23 * [http://www.python.org/ Python], version >= 2.4 and < 3.0 24 (note that we dropped the support for Python 2.3 in this release) 23 25 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 24 * [http://genshi.edgewall.org/wiki/Download Genshi], [genshi:source:trunk trunk], from svn, minimum required revision is [G1072]. 25 * You also need a database system and the corresponding python drivers for it. 26 The database can be either SQLite, PostgreSQL or MySQL. 27 28 === For SQLite === 26 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 27 28 You also need a database system and the corresponding python bindings. 29 The database can be either SQLite, PostgreSQL or MySQL. 30 31 ==== For the SQLite database #ForSQLite 29 32 30 33 If you're using Python 2.5 or 2.6, you already have everything you need. … … 39 42 }}} 40 43 41 That way, the latest SQLite version will be downloaded and built into the 42 bindings. 44 This will extract the SQLite code and build the bindings. 43 45 44 46 SQLite 2.x is no longer supported. For SQLite 3.x, the pysqlite 1.1.x … … 47 49 See additional information in [trac:PySqlite PySqlite]. 48 50 49 === For PostgreSQL ===51 ==== For the PostgreSQL database #ForPostgreSQL 50 52 51 53 You need to install the database and its Python bindings: 52 54 * [http://www.postgresql.org/ PostgreSQL] 53 * [http:// initd.org/projects/psycopg2 psycopg2]54 55 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details 56 57 58 === For MySQL ===55 * [http://pypi.python.org/pypi/psycopg2 psycopg2] 56 57 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 58 59 60 ==== For the MySQL database #ForMySQL 59 61 60 62 Trac can now work quite well with MySQL, provided you follow the guidelines. … … 63 65 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 64 66 65 See [trac:MySqlDb MySqlDb] for more detailed information. 66 It is ''very'' important to read carefully that page before creating the database. 67 68 === Optional Requirements === 67 It is '''very''' important to read carefully the [trac:MySqlDb MySqlDb] page before creating the database. 68 69 === Optional Dependencies 69 70 70 71 ==== Version Control System ==== 71 72 72 73 ===== Subversion ===== 73 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.74 75 * [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 [trac:TracSubversion TracSubversion] 76 [[br]] ''FIXME'' upgrade the requirements; it makes no sense to still support 1.0 or even 1.3, as Subversion itself only still supports 1.4.x 77 * 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), neither does it support the newer `ctype`-style bindings 78 * 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`.79 * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. 74 * [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. 75 76 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings 77 78 79 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 80 80 81 81 82 ===== Others ===== … … 84 85 85 86 ==== Web Server ==== 87 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. 88 89 Alternatively you configure Trac to run in any of the following environments. 90 * [http://httpd.apache.org/ Apache] with 91 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and 92 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac 93 - [http://modpython.org/ mod_python 3.3.1], see TracModPython) 94 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 95 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 96 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 86 97 * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 87 98 is highly discouraged''', better use one of the following options, 88 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or89 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web90 server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]), or91 * [http://httpd.apache.org/ Apache] with92 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] or93 http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac94 - [http://modpython.org/ mod_python 3.3.1], see TracModPython)95 99 96 100 97 101 ==== Other Python Packages ==== 98 102 99 * [http://babel.edgewall.org Babel], version >= 0.9. 4,103 * [http://babel.edgewall.org Babel], version >= 0.9.5, 100 104 needed for localization support 101 105 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 … … 116 120 117 121 == Installing Trac == 118 122 === Using `easy_install` 119 123 One way to install Trac is using `setuptools`. 120 With setuptools you can install Trac from the subversion repository; for example, 121 to install release version 0.12dev do: 122 {{{ 123 easy_install http://svn.edgewall.org/repos/trac/trunk 124 }}} 125 126 But of course the python-typical setup at the top of the source directory also works: 124 With setuptools you can install Trac from the subversion repository; 125 126 A few examples: 127 128 - install Trac 0.12 beta1:: 129 {{{ 130 easy_install Trac==0.12b1 131 }}} 132 133 - install latest development version 0.12dev 134 {{{ 135 easy_install Trac==dev 136 }}} 137 Note that in this case you won't have the possibility to run a localized version of Trac; 138 either use a released version or install from source 139 140 === From source 141 Of course, using the python-typical setup at the top of the source directory also works. 142 143 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12b1.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details). 144 127 145 {{{ 128 146 $ python ./setup.py install 129 147 }}} 130 See SubversionRepository for details about getting the source. 131 132 ''Note 1: you'll need root permissions or equivalent for this step.'' [[br]] 133 ''Note 2: installing from source is the preferred method if you want to have a localized version of Trac'' [[br]] 148 149 ''You'll need root permissions or equivalent for this step.'' 134 150 135 151 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory … … 138 154 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. 139 155 140 If you want to make Trac available in other languages, make sure you have installed Babel and then run this additional step before doing the `install` (or simply redo the `install` afterwards):156 If you install from source and want to make Trac available in other languages, make sure you have installed Babel and then run this additional step before doing the `install` (or simply redo the `install` afterwards): 141 157 {{{ 142 158 $ python ./setup.py compile_catalog -f … … 162 178 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 163 179 }}} 180 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 164 181 165 182 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. … … 168 185 == Creating a Project Environment == 169 186 170 A [ wiki: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 configuration fileand various other files and directories.187 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. 171 188 172 189 A new environment is created using [wiki:TracAdmin trac-admin]: … … 175 192 }}} 176 193 177 [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. 178 179 Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 180 181 ''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:'' 182 183 chown -R apache.apache /path/to/myproject 194 [TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value. 195 196 Using the default database connection string in particular will always work as long as you have SQLite installed. 197 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 198 199 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it. 200 201 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 202 203 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: 204 {{{ 205 # chown -R apache.apache /path/to/myproject 206 }}} 184 207 185 208 == Running the Standalone Server == … … 190 213 }}} 191 214 192 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. 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:215 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. 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: 193 216 {{{ 194 217 $ tracd -s --port 8000 /path/to/myproject … … 197 220 == Running Trac on a Web Server == 198 221 199 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. 200 222 Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi. 201 223 202 224 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. … … 204 226 ==== Generating the Trac cgi-bin directory ==== 205 227 206 In order for Trac to function properly with FastCGI or mod_python, you need to have a trac.cgi file. This is an executable which loads the appropriate Python code. Itcan be generated using the `deploy` option of [wiki:TracAdmin trac-admin].228 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]. 207 229 208 230 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: … … 216 238 ==== Setting up the Plugin Cache ==== 217 239 218 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 .240 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 on how to set environment variables. 219 241 220 242 == Configuring Authentication == … … 223 245 224 246 * TracStandalone if you use the standalone server, `tracd`. 225 * TracCgi if you use the CGI or FastCGI methods. 226 * TracModPython if you use the mod_python method. 227 247 * TracCgi if you use the CGI or FastCGI web front ends. 248 * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. 249 * TracModPython if you use the Apache mod_python web front end. 250 251 252 == Automatic reference to the SVN changesets in Trac tickets == 253 254 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: 255 * '''`Refs #123`''' - to reference this changeset in `#123` ticket 256 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 257 258 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. 259 {{{ 260 tracopt.ticket.commit_updater.* = enabled 261 }}} 262 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 228 263 229 264 == Using Trac == 230 265 231 Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.266 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. 232 267 233 268 Keep 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. … … 239 274 ---- 240 275 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 241