2020-02-04 14:23:15 +01:00
---
sidebar_navigation:
title: OpenProject Documentation
priority: 999
2020-12-17 13:23:37 +01:00
description: Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud.
2020-02-04 14:23:15 +01:00
keywords: help, documentation
2022-06-28 10:55:12 +02:00
---
2020-02-04 14:23:15 +01:00
# OpenProject Documentation
2014-10-02 15:38:10 +02:00
2025-05-28 11:59:21 +02:00
> [!NOTE]
> For enhanced usability, access the OpenProject documentation at [www.openproject.org/docs/](https://www.openproject.org/docs).
2020-02-04 14:23:15 +01:00
2017-03-16 14:12:09 +01:00
## Installation
2015-01-27 12:57:53 +01:00
2022-04-28 10:56:57 -04:00
Get started with installing and upgrading OpenProject using [our Installation Guide starting point ](./installation-and-operations/ ).
2015-01-27 12:57:53 +01:00
2022-12-07 12:14:21 +01:00
The guides [packaged ](./installation-and-operations/installation/packaged ) and [Docker-based ](./installation-and-operations/installation/docker ) installations are provided.
2017-03-16 14:12:09 +01:00
## Upgrading
2021-12-02 12:08:39 +01:00
The detailed upgrade instructions for our packaged installer are located on the [official website ](https://www.openproject.org/download-and-installation/ ).
2017-03-16 14:12:09 +01:00
2021-09-26 17:09:15 +02:00
The guides for [upgrading ](./installation-and-operations/operation/upgrading ) are provided.
2018-10-20 13:55:04 +03:00
2017-03-16 14:12:09 +01:00
## Operation
2021-09-26 17:09:15 +02:00
* [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 )
2017-03-16 14:12:09 +01:00
## User Guides
2022-04-28 10:56:57 -04:00
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.
2017-03-16 14:12:09 +01:00
## Development
2024-08-29 11:34:01 +02:00
* [Full development environment for developers ](./development/development-environment )
2021-09-26 17:09:15 +02:00
* [Developing plugins ](./development/create-openproject-plugin )
* [Developing OmniAuth Plugins ](./development/create-omniauth-plugin )
2025-10-17 09:50:33 +02:00
* [Running tests ](./development/testing )
2021-09-26 17:09:15 +02:00
* [Code review guidelines ](./development/code-review-guidelines )
* [API documentation ](./api )
2015-01-27 12:57:53 +01:00
2017-03-08 10:52:13 +01:00
## APIv3 documentation sources
2015-01-27 12:57:53 +01:00
2021-12-02 12:08:39 +01:00
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` .
