Redmine guide¶

Installation guide¶

• Installing Redmine
  • Email configuration
• Upgrading an existing installation
• Migrating from other systems

Administrator guide¶

• Managing projects
• Managing users
• Managing groups
• Roles and permissions
• Issue tracking system
• Custom fields
• Enumerations
• Application settings

Advanced configuration¶

• Configuring repositories
• Receiving emails
• Sending reminder emails
• LDAP Authentication

User guide¶

• User accounts
• User profiles
• Login
• Register

• Projects
• Search

• Project overview
• Project activity
• Issue tracking
  • Issue list
    • Change log
    • Issue summary
  • Roadmap
    • Version overview
• Time tracking
  • Spent-time details
  • Spent-time report
• Gantt
• Calendar
• News
• Documents
• Files
• Forums
• Wikis
• Repository
  • Statistics
• Project settings

• Files attached to Redmine resources

• Text formatting in Redmine

Developer guide¶

General development¶

• Coding Standards
• Redmine REST API
• Subversion instructions can be found on the usual download page and checking-out URL's on the checkout-page
• Using the Git Tracking Branch -- an alternative if you use Git
• Creating and applying patches
• An explanation of what changes may be in future Redmine releases
• A description of the content of both the Redmine plugin list and the Redmine theme list can be found at the "extension list info" page
• The release process for Redmine

Plugin development¶

• A step-by-step tutorial on writing a Redmine plugin
• A description of the internal handling of Redmine plugins
• A description of the Redmine plugin hooks API
• An incomplete list of available Redmine plugin hooks

Theme development¶

• A howto (HowTo create a custom Redmine theme) which explains how to create a custom Redmine theme

Alternative/Custom Authentication¶

• A howto (Alternative/custom authentication HowTo) for implementing authentication against a different database.

Translations of the Redmine guide¶

Note that the following translations may not be up to date. Please refer to the original english documentation if needed.

• French
• Japanese
• Japanese
• Russian
• Russian
• Simplified Chinese
• Spanish