Redmine guide¶

Installation guide¶

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

• Backing up and restoring Redmine

Administrator guide¶

• Application settings
• Roles and permissions
• Issue tracking system
• Custom fields
• Enumerations
• Managing projects
• Managing users
• LDAP Authentication
• Receiving emails
• Sending reminder emails

User guide¶

• Wiki formatting in Redmine

• Users accounts
• Login
• Register

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

Translations¶

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

• French
• Japanese
• Russian
• Simplified Chinese
• Spanish

Developer guide¶

General development¶

• Redmine REST API
• Code related topics
• Creating and applying patches
• An explanation of what changes may be in future Redmine releases
• List of vendored third-party core components
• Classes and methods of Redmine source code

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
• A list of frequently asked questions about Redmine plugins

Theme development¶

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

Contributing to Redmine¶

• Contribute
• Submissions on redmine.org