The Trac User and Administration Guide

The Trac Guide is meant to serve as a starting point for all documentation regarding Trac usage and development. The guide is a free document, a collaborative effort, and a part of the ​Trac Project itself.

Table of Contents

Currently available documentation:

• User Guide
  • Trac Wiki — How to use the built-in Wiki.
  • Trac Timeline — The timeline provides a historic perspective on a project.
  • Trac Rss — RSS content syndication in Trac.
  • The Version Control Subsystem
    • Trac Browser — Browsing source code with Trac.
    • Trac Changeset — Viewing changes to source code.
    • Trac Revision Log — Viewing change history.
  • The Ticket Subsystem
    • Trac Tickets — Using the issue tracker.
    • Trac Reports — Writing and using reports.
    • Trac Query — Executing custom ticket queries.
    • Trac Roadmap — The roadmap helps tracking project progress.
• Administrator Guide
  • Trac Install — How to install and run Trac.
  • Trac Upgrade — How to upgrade existing installations.
  • Trac Admin — Administering a Trac project.
  • Trac Import — Importing tickets from other bug databases.
  • Trac Ini — Trac configuration file reference.
  • Trac Permissions — Access control and permissions.
  • Trac Interface Customization — Customizing the Trac interface.
  • Trac Plugins — Installing and managing Trac extensions.
  • Trac Logging — The Trac logging facility.
  • Trac Notification — Email notification.
  • Trac Workflow — Configurable Ticket Workflow.
  • Trac Repository Admin — Management of Source Code Repositories.
• ​Trac FAQ — A collection of Frequently Asked Questions (on the project website).

Support and Other Sources of Information

If you are looking for a good place to ask a question about Trac, look no further than the ​MailingList. It provides a friendly environment to discuss openly among Trac users and developers.

See also the Trac Support page for more information resources.

Finally, developer documentation can be found in ​TracDev and its sub-pages.