Jens UlfertsOpenProject Community Guides
Installation
Get started with installing and upgrading OpenProject using our Installation Guide starting point.
The guides for manual and Docker-based installations are located here.
Upgrading
The detailed upgrade instructions for our packaged installer are located on the official website.
The guides for manual and Docker-based installations are located here.
Operation
- Backup guide
- 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.
Development
- Quick Start for developers
- 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 API Blueprint Format and its sources are being built from the entry point apiv3-documentation.apib.
You can use aglio to generate HTML documentation, e.g. using the following command:
aglio -i apiv3-documentation.apib -o api.html
The output of the API documentation at dev branch is continuously built and pushed to Github Pages at opf.github.io/apiv3-doc/.