Redmine guide¶

• Table of contents
• Redmine guide
  • Installation guide
  • Administrator guide
    • Common configuration
    • Advanced configuration
    • Maintenance operations
  • User guide
  • Developer guide
    • General development
    • Plugin development
    • Theme development
    • Contributing to Redmine
  • Translations of the 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¶

All following configuration settings can only be accessed and controlled by administrators, i.e. by users that have got the administrator flag checked.

Common configuration¶

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

Advanced configuration¶

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

Maintenance operations¶

• Rake tasks

User guide¶

• Getting Started
• User accounts
• Login
• Register
• Search
• My page

• Project overview
• Project activity
• Issue tracking
  • Issue list
    • 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
  • Textile
  • Markdown
  • Code highlighting supported languages

• Keyboard Navigation

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

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
• Russian
• Simplified Chinese
• Spanish