Changes between Version 384 and Version 386 of TracInstall
- Timestamp:
- (multiple changes)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInstall
v384 v386 5 5 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. 6 6 7 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.7 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. 8 8 9 9 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]. 10 10 11 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.11 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. 12 12 13 13 [[PageOutline(2-3,Installation Steps,inline)]] … … 22 22 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 23 23 24 You also need a database system and the corresponding python bindings. 25 The database can be either SQLite, PostgreSQL or MySQL. 24 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL. 26 25 27 26 ==== For the SQLite database #ForSQLite 28 27 29 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).30 31 However, if you 'dlike, you can download the latest and greatest version of [[trac:PySqlite]] from28 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. 29 30 However, if you like, you can download the latest and greatest version of [[trac:PySqlite]] from 32 31 [http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows 33 32 installers or the `tar.gz` archive for building from source: … … 38 37 }}} 39 38 40 This will download the latest SQLite code and build the bindings. 41 42 SQLite 2.x is no longer supported. 43 44 A known bug in [trac:PySqlite] versions 2.5.2-4 prohibits upgrades of Trac databases 45 from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 46 older. See #9434 for more detail. 47 48 See additional information in [trac:PySqlite PySqlite]. 39 This will download the latest SQLite code and build the bindings. SQLite 2.x is no longer supported. 40 41 A known bug in [trac: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]. 49 42 50 43 ==== For the PostgreSQL database #ForPostgreSQL … … 56 49 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 57 50 58 59 51 ==== For the MySQL database #ForMySQL 60 52 61 Trac can now work quite well with MySQL, provided you follow the guidelines.53 Trac works well with MySQL, provided you follow the guidelines: 62 54 63 55 * [http://mysql.com/ MySQL], version 5.0 or later 64 56 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 65 57 66 It is '''very''' important to read carefully the[trac:MySqlDb] page before creating the database.58 Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database. 67 59 68 60 === Optional Dependencies … … 77 69 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. 78 70 79 80 71 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported]. 81 82 72 83 73 ===== Others … … 88 78 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below. 89 79 90 Alternatively you can configure Trac to run in any of the following environments .80 Alternatively you can configure Trac to run in any of the following environments: 91 81 * [http://httpd.apache.org/ Apache] with 92 82 - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and … … 115 105 an internal time zone implementation. 116 106 117 '''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]. 118 119 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!). 120 107 '''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]. 108 109 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! 121 110 122 111 == Installing Trac 123 112 === Using `easy_install` 124 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 125 With setuptools you can install Trac from the Subversion repository; 113 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. With setuptools you can install Trac from the Subversion repository. 126 114 127 115 A few examples: … … 166 154 Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip. 167 155 168 169 170 156 === From source 171 Of course, using the python-typical setup at the top of the source directory also works. 172 173 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). 157 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. 174 158 175 159 {{{#!sh … … 177 161 }}} 178 162 179 ''You 'll need root permissions or equivalent for this step.''163 ''You will need root permissions or equivalent for this step.'' 180 164 181 165 This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory … … 211 195 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. 212 196 213 214 197 == Creating a Project Environment 215 198 216 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 variousother files and directories.199 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. 217 200 218 201 A new environment is created using [wiki:TracAdmin trac-admin]: … … 230 213 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 231 214 232 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).215 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. 233 216 234 217 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: … … 242 225 '''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there. 243 226 }}} 244 245 227 246 228 == Deploying Trac … … 295 277 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory. 296 278 297 298 279 ==== Mapping Static Resources 299 280 … … 361 342 }}} 362 343 363 364 344 ==== Setting up the Plugin Cache 365 345