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.
The guides [packaged](./installation-and-operations/installation/packaged) and [Docker-based](./installation-and-operations/installation/docker) installations are provided.
@ -41,5 +41,5 @@ Compare the features of these versions [on the website](https://www.openproject.
For production environments and when using a [supported distribution](system-requirements), we recommend using the [packaged installation](installation/packaged/). This will install OpenProject as a system dependency using your distribution's package manager, and provide updates in the same fashion that all other system packages do.
A [manual installation](installation/manual) option is also documented, but due to the large number of components involved and the rapid evolution of OpenProject, we cannot ensure that the procedure is either up-to-date or that it will correctly work on your machine. This means that manual installation is NOT recommended.
An OUTDATED and OLD [manual installation](installation/manual) option exists, but due to the large number of components involved and the rapid evolution of OpenProject, we cannot ensure that the procedure is either up-to-date or that it will correctly work on your machine. This means that manual installation is NOT recommended NOR supported.
@ -22,7 +22,7 @@ If you use the docker images, you need to be familiar with Docker and Docker vol
### My favorite Linux distribution is not listed. What can I do?
You can either try the manual installation, or ask in the forum whether this could be added to the list of supported distributions. We try to support recent major distributions, but due to maintenance and operations cost cannot freely add to that list.
You can either try the OUTDATED and OLD manual installation guide, or add a Feature request whether your operating system could be added to the list of supported distributions. We try to support recent major distributions, but due to maintenance and operations cost cannot freely add to that list.
### What is the better option to run OpenProject in production environments: Docker or Linux packages?
| [Installation with DEB/RPM packages](./packaged) | This is the recommended way to install OpenProject |
| [Installation with docker](./docker) | This allows to setup OpenProject in an isolated manner using Docker |
| [Installation with Univention Corporate Server](./univention) | OpenProject is available in the App Center and comes integrated with the identity management |
| [Other](misc/) | Extra information on installing OpenProject on specific platforms such as Kubernetes. |
| [Installation with DEB/RPM packages](./packaged) | This is the recommended way to install OpenProject |
| [Installation with Docker](./docker) | This allows to setup OpenProject in an isolated manner using Docker |
| [Installation with Univention Corporate Server](./univention) | OpenProject is available in the App Center and comes integrated with the identity management |
| [Other](misc/) | Extra information on installing OpenProject on specific platforms such as Kubernetes. |
**We recommend downloading the DEB/RPM package installation.**
> **NOTE: We recommend using the DEB/RPM package installation.**
## Frequently asked questions (FAQ)
### Do you have a step-by-step guide to installing OpenProject Enterprise on-premises under Active Directory?
We have a guide on [how to use OpenProject with your Active Directory](../../system-admin-guide/authentication/ldap-authentication/).
In addition, with the Enterprise on-premises edition it is also possible to [link LDAP groups with groups in OpenProject](../../system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/).
**IMPORTANT: We strongly recommend to use one of the officially supported [installation methods](../../installation). This guide is simply provided as a reference, and is most likely NOT up to date with relation to the latest OpenProject releases.**
> **IMPORTANT: We strongly recommend to use one of the officially supported [installation methods](../../installation).**
>
> **This guide is simply provided as an OLD and OUTDATED reference, and is NOT up to date with relation to the latest OpenProject releases and will be NOT maintained NOR supported. You are on your own and maybe could ask experienced users in the forum in order to use this guide for any integrations taht you would like to solve. We also removed it from the navigation sidebar on the left in order to hide it.**
Please be aware that:
* This guide requires that you have a clean Ubuntu 18.04 **x64** installation
* This guide **requires** that you have a clean **Ubuntu 18.04****x64** installation
with administrative rights (i.e. you must be able to `sudo`). We have tested
the installation guide on an Ubuntu Server image, but it should work on any
derivative. You may need to alter some of the commands to match your
derivative.
* OpenProject will be installed with a PostgreSQL database.
* OpenProject will be installed with a **PostgreSQL** database.
* OpenProject will be served in a production environment with the Apache server
* OpenProject will be served in a production environment with the **Apache** server
(this guide should work similarly with other servers, like nginx and others)
Note: We have highlighted commands to execute like this
> **NOTE:** We have highlighted commands to execute like this
```bash
[user@host] command to execute
@ -147,7 +149,7 @@ v16.17.0
## Installation of OpenProject
We will install the OpenProject Community edition. It contains the recommended set of plugins for use
We will install the OpenProject Community Edition. It contains the recommended set of plugins for use
with OpenProject. For more information, see [github.com/opf/openproject](https://github.com/opf/openproject).
@ -213,11 +215,8 @@ a better performance of OpenProject:
rails_cache_store: :memcache
```
__NOTE:__ You should validate your `yml` files, for example with
[yamlchecker.com](https://yamlchecker.com/). Both, the `database.yml` and `configuration.yml`
file are sensitive to whitespace. It is pretty easy to write
invalid `yml` files without seeing the error. Validating those files
prevents you from such errors.
> __NOTE:__ You should validate your `yml` files, for example with [yamlchecker.com](https://yamlchecker.com/). Both, the `database.yml` and `configuration.yml` file are sensitive to whitespace. It is pretty easy to write invalid `yml` files without seeing the error. Validating those files prevents you from such errors.
>
To configure the environment variables such as the number of web server threads `OPENPROJECT_WEB_WORKERS`, copy the `.env.example` to `.env` and add the environment variables you want to configure. The variables will be automatically loaded to the application's environment.
@ -231,7 +230,8 @@ To configure the environment variables such as the number of web server threads
**NOTE:** When not specified differently, the default data loaded via db:seed will have an english localization. You can choose to seed in a different language by specifying the language via the `LOCALE` environment variable on the call to `db:seed`. E.g.
> **NOTE:** When not specified differently, the default data loaded via db:seed will have an english localization. You can choose to seed in a different language by specifying the language via the `LOCALE` environment variable on the call to `db:seed`. E.g.
@ -75,7 +75,7 @@ In OpenProject 12.2, you are now able to mark work packages with notifications a
In 12.2, the way settings are being handled for controlling HTTPs mode of OpenProject have changed.
In case of a packaged installation, the configuration from the packager wizard will result in the correct configuration.
For docker and manual installations, you will need to set the environment variable `OPENPROJECT_HTTPS=false` if you actively want to disable HTTPS mode.
For docker you will need to set the environment variable `OPENPROJECT_HTTPS=false` if you actively want to disable HTTPS mode.
For more information, please see the respective installation pages:
@ -42,7 +42,7 @@ For cloud customers of OpenProject: The records affected by this bug were restor
## Changes to the HTTPS settings
If you are running OpenProject in a docker-based or manual installation, or if you manually integrate the packaged installation into your existing web server, you might need to set a new configuration value if you're not running under HTTPS.
If you are running OpenProject in a docker-based or if you manually integrate the packaged installation into your existing web server, you might need to set a new configuration value if you're not running under HTTPS.
For these installations, you will need to set the environment variable `OPENPROJECT_HTTPS=false` if you actively want to disable HTTPS mode.
adam-op
2 years ago
committed by
Oliver Günther