The Trac User and Administration Guide

[[InterTrac]]

Provide a list of known InterTrac prefixes.

[[TitleIndex]]

Insert an alphabetic list of all wiki pages into the output. Accepts a …

[[RecentChanges]]

List all pages that have recently been modified, grouping them by the day …

[[PageOutline]]

Display a structural outline of the current wiki page, each item in the …

[[Image]]

Embed an image in wiki-formatted text. The first argument is the file …

[[MacroList]]

Display a list of all installed Wiki macros, including documentation if …

[[TracIni]]

Produce documentation for the Trac configuration file. Typically, this …

[[KnownMimeTypes]]

List all known mime-types which can be used as WikiProcessors. Can be …

[[TracGuideToc]]

Display a table of content for the Trac guide. This macro shows a quick …

[[TracAdminHelp]]

Display help for trac-admin commands. Examples: […]

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria. This macro …

[[RepositoryIndex]]

Display the list of available repositories. Can be given a …

[[InterWiki]]

Provide a description list for the known InterWiki prefixes.

[[TOC]]

Generate a table of contents for the current page or a set of pages. If no …

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.

Table of Contents

Currently available documentation:

• TracGuide (This page) -- Documentation starting point.
• Administrator Guide
  • TracInstall -- How to install and run Trac.
  • TracUpgrade -- How to upgrade existing installations.
  • TracAdmin -- Administering a Trac project.
  • TracImport -- Importing tickets from other bug databases.
  • TracIni -- Trac configuration file reference.
  • TracPermissions -- Access control and permissions.
  • TracInterfaceCustomization -- Customizing the Trac interface.
  • TracPlugins -- Installing and managing Trac extensions.
  • TracLogging -- The Trac logging facility.
  • TracNotification -- Email notification.
  • TracWorkflow -- Configurable Ticket Workflow.
• User Guide
  • TracWiki -- How to use the built-in Wiki.
  • TracTimeline -- The timeline provides a historic perspective on a project.
  • TracRss -- RSS content syndication in Trac.
  • The Version Control Subsystem
    • TracBrowser -- Browsing source code with Trac.
    • TracChangeset -- Viewing changes to source code.
    • TracRevisionLog -- Viewing change history.
  • The Ticket Subsystem
    • TracTickets -- Using the issue tracker.
    • TracReports -- Writing and using reports.
    • TracQuery -- Executing custom ticket queries.
    • TracRoadmap -- The roadmap helps tracking project progress.
•  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 TracSupport page for more information resources.