---
sidebar_navigation:
  title: OpenProject Documentation
  priority: 999
description: Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud.
robots: index, follow
keywords: help, documentation
---
# OpenProject Documentation

<div class="alert alert-info" role="alert">
**Note**: To better read our OpenProject Documentation, please go to [www.openproject.org/docs/](https://www.openproject.org/docs/).
</div>

## Installation

Get started with installing and upgrading OpenProject using [our Installation Guide starting point](./installation-and-operations/).

The guides for [manual](./installation-and-operations/installation/manual), [packaged](./installation-and-operations/installation/packaged) and [Docker-based](./installation-and-operations/installation/docker) installations are provided.

## Upgrading

The detailed upgrade instructions for our packaged installer are located on the [official website](https://www.openproject.org/download-and-installation/).

The guides for [upgrading](./installation-and-operations/operation/upgrading) are provided.

## Operation

* [Backing up you installation](./installation-and-operations/operation/backing-up)
* [Alter configuration of OpenProject](./installation-and-operations/configuration)
* [Manual repository integration for Git and Subversion](./installation-and-operations/configuration/repositories)
* [Configure incoming mails](./installation-and-operations/configuration/incoming-emails)
* [Install custom plugins](./installation-and-operations/configuration/plugins)


## User Guides

Please see our [User Guide pages](./user-guide/) for detailed documentation on the functionality of OpenProject.

## Use Cases

Please see our [Use Cases section](./use-cases/) 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 on Ubuntu](./development/development-environment-ubuntu) and [Mac OS X](./development/development-environment-osx)
* [Developing plugins](./development/create-openproject-plugin)
* [Developing OmniAuth Plugins](./development/create-omniauth-plugin)
* [Running tests](./development/running-tests)
* [Code review guidelines](./development/code-review-guidelines)
* [API documentation](./api)


## APIv3 documentation sources

The documentation for APIv3 is written in the [OpenAPI Format](https://www.openapis.org/) and its sources are being built from the entry point `openapi-spec.yml`.