OpenProject Documentation

[!NOTE] For enhanced usability, access the OpenProject documentation at www.openproject.org/docs/.

Installation

Get started with installing and upgrading OpenProject using our Installation Guide starting point.

The guides for packaged and Docker-based installations are provided.

Upgrading

The detailed upgrade instructions for our packaged installer are located on the official website.

The guides for upgrading are provided.

Operation

• Backing up your installation
• Alter configuration of OpenProject
• Manual repository integration for Git and Subversion
• Configure incoming mails
• Install custom plugins

User Guides

Please see our User Guide pages for detailed documentation on the functionality of OpenProject.

Use Cases

Please see our Use Cases section for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.

Development

• Full development environment for developers
• Developing plugins
• Developing OmniAuth Plugins
• Running tests
• Code review guidelines
• API documentation

APIv3 documentation sources

The documentation for APIv3 is written in the OpenAPI Format and its sources are being built from the entry point openapi-spec.yml.