Legend:

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.

5

5

6

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

8

If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].

9

10

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.

6

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.

7

8

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].

9

10

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], please '''first read through these general instructions''' to get a good understanding of the tasks involved.

As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).

28

29

Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.

45

30

46

31

==== For the PostgreSQL database #ForPostgreSQL

47

32

48

33

You need to install the database and its Python bindings:

49

* [http://www.postgresql.org/ PostgreSQL]

50

* [http://pypi.python.org/pypi/psycopg2 psycopg2]

34

* [http://www.postgresql.org/ PostgreSQL], version 8.0 or later

35

* [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later

51

36

52

37

See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.

53

38

54

55

39

==== For the MySQL database #ForMySQL

56

40

57

Trac can now work quite well with MySQL, provided you follow the guidelines.

41

Trac works well with MySQL, provided you follow the guidelines:

58

42

59

43

* [http://mysql.com/ MySQL], version 5.0 or later

60

44

* [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later

61

45

62

It is '''very''' important to read carefully the [trac:MySqlDb MySqlDb] page before creating the database.

46

Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.

63

47

64

48

=== Optional Dependencies

65

49

66

==== Version Control System ====

67

68

===== Subversion =====

69

* [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.

70

71

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

72

73

74

'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].

75

76

77

===== Others =====

78

79

Support for other version control systems is provided via third-parties. See [trac:PluginList PluginList] and [trac:VersioningSystemBackend VersioningSystemBackend].

80

81

==== Web Server ====

82

A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below.

83

84

Alternatively you configure Trac to run in any of the following environments.

50

==== Subversion

51

52

[http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.

53

54

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.)

55

56

For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.

57

58

{{{#!div style="border: 1pt dotted; margin: 1em"

59

**Note:**

60

* Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.

61

* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:ticket:493 not supported].

62

}}}

63

64

==== Git

65

66

[http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.

67

68

==== Other Version Control Systems

69

70

Support for other version control systems is provided via third-party plugins. See [trac:PluginList#VersionControlSystems] and [trac:VersionControlSystem].

71

72

==== Web Server

73

A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.

74

75

Alternatively you can configure Trac to run in any of the following environments:

85

76

* [http://httpd.apache.org/ Apache] with

86

- [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] and

87

http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac

88

- [http://modpython.org/ mod_python 3.3.1], see TracModPython)

77

- [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and

[http://gnu.org/software/enscript/enscript.html Enscript] may still be used

106

but are deprecated and you really should be using Pygments.

94

* [http://pygments.org Pygments] for

95

[TracSyntaxColoring syntax highlighting].

107

96

* [http://pytz.sf.net pytz] to get a complete list of time zones,

108

97

otherwise Trac will fall back on a shorter list from

109

98

an internal time zone implementation.

110

99

111

'''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 [trac:MailingList MailingList] or [trac:IrcChannel IrcChannel].

112

113

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!).

114

115

116

== Installing Trac ==

100

{{{#!div style="border: 1pt dotted; margin: 1em"

101

**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].

102

}}}

103

104

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''.

105

106

== Installing Trac

107

108

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.

109

110

It is assumed throughout this guide that you have elevated permissions as the `root` user or by prefixing commands with `sudo`. The umask `0002` should be used for a typical installation on a Unix-based platform.

111

117

112

=== Using `easy_install`

118

One way to install Trac is using `setuptools`.

119

With setuptools you can install Trac from the subversion repository;

113

Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].

Note that in this case you won't have the possibility to run a localized version of Trac;

133

126

either use a released version or install from source

134

127

128

More information can be found on the [trac:wiki:setuptools setuptools] page.

129

130

{{{#!div style="border: 1pt dotted; margin: 1em"

131

**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 [#DeployingTrac Deploying Trac].

132

}}}

133

135

134

=== Using `pip`

136

135

'pip' is an easy_install replacement that is very useful to quickly install python packages.

137

To get a trac installation up and running in less than 5 minutes:

138

139

Assuming you want to have your entire pip installation in /opt/user/trac

136

To get a Trac installation up and running in less than 5 minutes:

137

138

Assuming you want to have your entire pip installation in `/opt/user/trac`

140

139

141

140

-

142

{{{

143

pip -E /opt/user/trac install trac psycopg2

141

{{{#!sh

142

pip install trac psycopg2

144

143

}}}

145

144

or

146

145

-

147

{{{

148

pip -E /opt/user/trac install trac mysql-python

149

}}}

150

151

Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.

152

153

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

154

155

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)

156

157

Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.

158

159

146

{{{#!sh

147

pip install trac mysql-python

148

}}}

149

150

Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.

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)

155

156

Additionally, you can install several Trac plugins (listed [https://pypi.python.org/pypi?:action=browse&show=all&c=516 here]) through pip.

160

157

161

158

=== From source

162

Of course, using the python-typical setup at the top of the source directory also works.

163

164

You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-0.12.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).

165

166

{{{

159

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.

160

161

{{{#!sh

167

162

$ python ./setup.py install

168

163

}}}

169

164

170

''You'll need root permissions or equivalent for this step.''

171

172

This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory

173

of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.

174

175

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.

176

177

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):

178

{{{

165

''You will need root permissions or equivalent for this step.''

166

167

This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory

168

of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.

169

170

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):

171

{{{#!sh

179

172

$ python ./setup.py install

180

173

}}}

181

Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).

182

183

=== Advanced Options ===

174

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`).

175

176

=== Using installer

177

178

On Windows, Trac can be installed using the exe installers available on the [trac:TracDownload] page. Installers are available for the 32-bit and 64-bit versions of Python. Make sure to use the installer that matches the architecture of your Python installation.

179

180

=== Using package manager

181

182

Trac may be available in your platform's package repository. Note however, that the version provided by your package manager may not be the latest release.

183

184

=== Advanced `easy_install` Options

184

185

185

186

To install Trac to a custom location, or find out about other advanced installation options, run:

186

{{{

187

{{{#!sh

187

188

easy_install --help

188

189

}}}

189

190

190

Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.

191

Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.

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.

203

204

205

== Creating a Project Environment ==

206

207

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.

The `tracd` and `trac-admin` commands will be placed in `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.6/site-packages`, which is Apple's preferred location for third-party Python application installations.

206

}}}

207

208

== Creating a Project Environment

209

210

A [TracEnvironment Trac environment] is the backend where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is a directory that contains a human-readable [TracIni configuration file], and other files and directories.

211

212

A new environment is created using [TracAdmin trac-admin]:

213

{{{#!sh

211

214

$ trac-admin /path/to/myproject initenv

212

215

}}}

213

216

214

[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.

215

216

Using the default database connection string in particular will always work as long as you have SQLite installed.

217

For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.

218

219

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.

220

221

Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.

217

[TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.

218

219

Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.

220

221

Also note that the values you specify here can be changed later using TracAdmin or directly editing the [TracIni conf/trac.ini] configuration file.

222

223

{{{#!div style="border: 1pt dotted; margin: 1em"

224

**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, or HFS+ on OSX), 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.

225

}}}

222

226

223

227

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:

224

{{{

225

# chown -R apache.apache /path/to/myproject

226

}}}

227

228

== Running the Standalone Server ==

229

230

After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:

231

{{{

228

{{{#!sh

229

$ chown -R apache:apache /path/to/myproject

230

}}}

231

232

The actual username and groupname of the apache server may not be exactly `apache`, and are specified in the Apache configuration file by the directives `User` and `Group` (if Apache `httpd` is what you use).

233

234

{{{#!div class=important

235

'''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there.

236

}}}

237

238

== Deploying Trac

239

240

{{{#!div style="border: 1pt dotted; margin: 1em"

241

**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.

242

243

If running `tracd`, the environment variable can be set system-wide or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.

244

245

To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.

246

{{{#!sh

247

export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1

248

}}}

249

250

Alternatively, the variable can be set in the shell before executing `tracd`:

If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`.

256

}}}

257

258

=== Running the Standalone Server

259

260

After having created a Trac environment, you can easily try the web interface by running the standalone server [TracStandalone tracd]:

261

{{{#!sh

232

262

$ tracd --port 8000 /path/to/myproject

233

263

}}}

234

264

235

265

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:

236

{{{

266

{{{#!sh

237

267

$ tracd -s --port 8000 /path/to/myproject

238

268

}}}

239

269

240

== Running Trac on a Web Server ==

241

242

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.

243

244

Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS.

245

246

==== Generating the Trac cgi-bin directory ====

247

248

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].

249

250

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:

251

{{{

270

=== Running Trac on a Web Server

271

272

Trac provides various options for connecting to a "real" web server:

273

- [TracFastCgi FastCGI]

274

- [wiki:TracModWSGI Apache with mod_wsgi]

275

- [TracModPython Apache with mod_python]

276

- //[TracCgi CGI] (should not be used, as the performance is far from optimal)//

277

278

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.

279

280

==== Generating the Trac cgi-bin directory #cgi-bin

281

282

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].

283

284

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:

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.

261

262

== Configuring Authentication ==

263

264

The 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:

265

266

* TracStandalone if you use the standalone server, `tracd`.

267

* TracCgi if you use the CGI or FastCGI web front ends.

268

* [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end.

269

* TracModPython if you use the Apache mod_python web front end.

270

271

272

== Automatic reference to the SVN changesets in Trac tickets ==

273

274

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:

275

* '''`Refs #123`''' - to reference this changeset in `#123` ticket

276

* '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''

277

278

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.

279

{{{

280

tracopt.ticket.commit_updater.* = enabled

281

}}}

282

For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel.

283

284

== Using Trac ==

291

Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.

292

293

==== Mapping Static Resources

294

295

Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.

296

297

Web servers such as [http://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.

298

299

There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.

300

301

A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.

302

303

The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:

304

[[TracAdminHelp(deploy)]]

305

306

The target `<directory>` will contain an `htdocs` directory with:

307

- `common/` - the static resources of Trac

308

- `site/` - a copy of the environment's `htdocs/` directory

309

- `shared` - the static resources shared by multiple Trac environments, with a location defined by the `[inherit]` `htdocs_dir` option

310

- `<plugin>/` - one directory for each resource directory provided by the plugins enabled for this environment

311

312

The example that follows will create a single `/chrome` alias. If that isn't the correct approach for your installation you simply need to create more specific aliases:

313

{{{#!apache

314

Alias /trac/chrome/common /path/to/trac/htdocs/common

315

Alias /trac/chrome/site /path/to/trac/htdocs/site

316

Alias /trac/chrome/shared /path/to/trac/htdocs/shared

317

Alias /trac/chrome/<plugin> /path/to/trac/htdocs/<plugin>

318

}}}

319

320

===== Example: Apache and `ScriptAlias` #ScriptAlias-example

321

322

Assuming the deployment has been done this way:

323

{{{#!sh

324

$ trac-admin /var/trac/env deploy /path/to/shared/trac

325

}}}

326

327

Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application:

328

{{{#!apache

329

Alias /trac/chrome /path/to/trac/htdocs

330

331

<Directory "/path/to/www/trac/htdocs">

332

# For Apache 2.2

333

<IfModule !mod_authz_core.c>

334

Order allow,deny

335

Allow from all

336

</IfModule>

337

# For Apache 2.4

338

<IfModule mod_authz_core.c>

339

Require all granted

340

</IfModule>

341

</Directory>

342

}}}

343

344

If using mod_python, add this too, otherwise the alias will be ignored:

345

{{{#!apache

346

<Location "/trac/chrome/common">

347

SetHandler None

348

</Location>

349

}}}

350

351

Alternatively, if you wish to serve static resources directly from your project's `htdocs` directory rather than the location to which the files are extracted with the `deploy` command, you can configure Apache to serve those resources. Again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation:

352

{{{#!apache

353

Alias /trac/chrome/site /path/to/projectenv/htdocs

354

355

<Directory "/path/to/projectenv/htdocs">

356

# For Apache 2.2

357

<IfModule !mod_authz_core.c>

358

Order allow,deny

359

Allow from all

360

</IfModule>

361

# For Apache 2.4

362

<IfModule mod_authz_core.c>

363

Require all granted

364

</IfModule>

365

</Directory>

366

}}}

367

368

Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:

369

{{{#!ini

370

[trac]

371

htdocs_location = http://static.example.org/trac-common/

372

}}}

373

374

Note that this makes it easy to have a dedicated domain serve those static resources, preferentially cookie-less.

375

376

Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:

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.

384

385

== Configuring Authentication

386

387

Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the `REMOTE_USER` variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.

388

389

The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.

390

391

Please refer to one of the following sections:

392

* TracStandalone#UsingAuthentication if you use the standalone server, `tracd`.

393

* [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi`, `mod_python`, `mod_fcgi` or `mod_fastcgi`.

394

* TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx)

395

396

[trac:TracAuthenticationIntroduction] also contains some useful information for beginners.

397

398

== Granting admin rights to the admin user

399

Grant admin rights to user admin:

400

{{{#!sh

401

$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN

402

}}}

403

404

This user will have an //Admin// navigation item that directs to pages for administering your Trac project.

405

406

== Configuring Trac

407

408

TracRepositoryAdmin provides information on configuring version control repositories for your project.

409

410

== Using Trac

285

411

286

412

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.

287

413

288

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.

414

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.