The Trac User and Administration Guide

The TracGuide 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.

Introduction

Trac is an enhanced wiki and issue tracking system for software development projects. Trac uses a minimalistic approach to web-based software project management. It helps developers write great software while staying out of the way. Trac should impose as little as possible on a team's established development process and policies.

It provides an interface to Subversion as well as other version control systems, an integrated Wiki and convenient reporting facilities.

Trac allows wiki markup in issue descriptions and commit messages, creating links and seamless references between bugs, tasks, changesets, files and wiki pages. A timeline shows all current and past project events in order, making the acquisition of an overview of the project and tracking progress very easy. The roadmap shows the road ahead, listing the upcoming milestones.

User Guide

• Using the Wiki subsystem:
  • TracWiki — How to use the built-in Wiki.
  • WikiFormatting — Reference to the wiki syntax used throughout.
• Using the Version Control subsystem:
  • TracBrowser — Browsing source code with Trac.
  • TracChangeset — Viewing changes to source code.
  • TracRevisionLog — Viewing change history.
• Using the Ticket subsystem:
  • TracTickets — Using the issue tracker.
  • TracRoadmap — The roadmap helps tracking project progress.
  • TracReports — Writing and using reports.
  • TracQuery — Executing custom ticket queries.
  • TracBatchModify - Modifying a batch of tickets in one request.
• Other modules and general topics:
  • TracSearch — Full text search in all content.
  • TracTimeline — The timeline provides a historic perspective on a project.
  • TracRss — RSS content syndication in Trac.
  • TracAccessibility — Accessibility keys support.

Administrator Guide

• Installation and upgrade:
  • TracInstall — How to install and run Trac.
  • TracUpgrade — How to upgrade existing installations.
  • TracImport — Importing tickets from other bug databases.
  • TracPlugins — Installing and managing Trac extensions.
• Configuration and customization:
  • TracIni — Trac configuration file reference.
  • TracPermissions — Access control and permissions.
  • TracNavigation — Customize main navigation menus.
  • TracInterfaceCustomization — Customizing the Trac interface.
  • TracLogging — The Trac logging facility.
• Administering the Version Control subsystem:
  • TracRepositoryAdmin — Management of Source Code Repositories.
• Administering the Ticket subsystem:
  • TracTicketsCustomFields — Expanding tickets with customized fields.
  • TracNotification — Email notification.
  • TracWorkflow — Configurable Ticket Workflow.
• Reference:
  • TracEnvironment — All you need to know about Trac environments.
  • TracAdmin — Administering a Trac project via the command-line.

Support and Other Sources of Information

• ​Trac FAQ — A collection of Frequently Asked Questions on the project website.
• ​TracDev and ​API docs — Trac Developer documentation.
• TracSupport — How to get more information.

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