Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/release/14.5' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
ulferts committed Sep 12, 2024
2 parents b08b954 + 4b98d5d commit 1485df4
Show file tree
Hide file tree
Showing 14 changed files with 145 additions and 98 deletions.
16 changes: 8 additions & 8 deletions docs/installation-and-operations/installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ sidebar_navigation:

# Installing OpenProject

OpenProject can be setup in three different ways:
OpenProject can be setup in these different ways:

| Topic | Content |
| ------------------------------------------------ | ------------------------------------------------------------ |
| [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 Kubernetes](./kubernetes) | This allows to setup OpenProject using Kubernetes |
| [Installation with Helm charts](./helm-chart) | This allows to setup OpenProject using Helm charts |
| [Other](misc/) | Extra information on installing OpenProject on specific platforms such as Kubernetes. |
| Topic | Content |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [Installation with DEB/RPM packages](./packaged) | This is the recommended way to install OpenProject |
| [Installation with Docker Compose](./docker-compose) | This allows to setup OpenProject in an isolated manner using Docker Compose |
| [Installation with single Docker container](./docker)| This allows to setup OpenProject in a single Docker container |
| [Installation with Helm charts](./helm-chart) | This allows to setup OpenProject using Helm charts |
| [Other](misc/) | Extra information on installing OpenProject on specific platforms such as Kubernetes. |

> **NOTE: We recommend using the DEB/RPM package installation.**
Expand Down
71 changes: 10 additions & 61 deletions docs/installation-and-operations/installation/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
sidebar_navigation:
title: Docker
title: Docker (all-in-one)
priority: 300
---

# Install OpenProject with Docker
# OpenProject on Docker all-in-one container

[Docker](https://www.docker.com) is a way to distribute self-contained applications easily. We provide a Docker image for the Community edition that you can very easily
install and upgrade on your servers. However, contrary to the manual or package-based installation, your machine needs to have the Docker Engine
installed first, which usually requires a recent operating system. Please see the [Docker Engine installation page](https://docs.docker.com/install/) if you don't have Docker installed.

***

**Supported architectures**
## Supported architectures

Starting with OpenProject 12.5.6 we publish our containers for three architectures.

Expand All @@ -24,75 +24,24 @@ The OpenProject **BIM Edition** is only supported on AMD64, however.

***

**Limitations**
## Limitations

Note that the docker container setup does not allow for integration of repositories within OpenProject. You can reference external repositories, but cannot set them up through OpenProject itself.
For that feature to work, you need to use the packaged installation method.

**Overview**
## Overview

OpenProject's docker setup can be launched in two ways:

1. Multiple containers (recommended), each with a single process inside, using a Compose file. Allows to easily choose which services you want to run, and simplifies scaling and monitoring aspects.
### One container per process (recommend)

2. One container with all the processes inside. Easy but not recommended for production. This is the legacy behavior.
This is the recommended approach for using OpenProject with Docker, where each component has a single container inside, orchestrated using a Compose file. Allows to easily choose which services you want to run, and simplifies scaling and monitoring aspects.

## One container per process (recommended)
Please follow the [OpenProject for Docker compose](../docker-compose/) documentation for this installation method

### Quick Start

First, you must clone the [openproject-deploy](https://github.com/opf/openproject-deploy/tree/stable/14/compose) repository:

```shell
git clone https://github.com/opf/openproject-deploy --depth=1 --branch=stable/14 openproject
```

Then, change into the compose folder, this folder will be the location where you enter all following commands:

```shell
cd openproject/compose
```

Make sure you are using the latest version of the Docker images:

```shell
docker-compose pull
```

Launch the containers:

```shell
OPENPROJECT_HTTPS=false docker-compose up -d
```

After a while, OpenProject should be up and running on `http://localhost:8080`. The default username and password is login: `admin`, and password: `admin`. You need to explicitly disable HTTPS mode on startup as OpenProject assumes it's running behind HTTPS in production by default.

> **Note:** The `docker-compose.yml` file present in the repository can be adjusted to your convenience. With each pull it will be overwritten. Best practice is to use the file `docker-compose.override.yml` for that case. For instance you could mount specific configuration files, override environment variables, or switch off services you don't need. Please refer to the official [Docker Compose documentation](https://docs.docker.com/compose/extends/) for more details.
You can stop the Compose stack by running:

```shell
docker-compose stop
```

You can stop and remove all containers by running:

```shell
docker-compose down
```

This will not remove your data which is persisted in named volumes, likely called `compose_opdata` (for attachments) and `compose_pgdata` (for the database). The exact name depends on the name of the directory where your `docker-compose.yml` and/or you `docker-compose.override.yml` files are stored (`compose` in this case).

If you want to start from scratch and remove the existing data you will have to remove these volumes via
`docker volume rm compose_opdata compose_pgdata`.

### Configuration

Please see the [advanced configuration guide's docker paragraphs](../../configuration/#docker)

#### BIM edition
### Single docker container

In order to install or change to BIM inside a Docker environment, please navigate to the [Docker Installation for OpenProject BIM](../../bim-edition/#docker-installation-openproject-bim) paragraph at the BIM edition documentation.
This guide will show you to install OpenProject in one container with all the processes inside. This allows for a very quick start but is not recommended for production as it hinders upgradability of the different components such as the database.

## All-in-one container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ sidebar_navigation:
# Kubernetes

Kubernetes is a container orchestration tool. As such it can use the
OpenProject docker container in the same manner as shown in the [docker section](../docker/#one-container-per-process-recommended).
OpenProject docker container in the same manner as shown in the [docker section](../docker/).

In the [openproject-deploy](https://github.com/opf/openproject-deploy/blob/stable/14/kubernetes/README.md) repository we provide further information and an exemplary set of YAML files defining a complete OpenProject setup on Kubernetes.
If you'd like to run OpenProject on Kubernetes, please take a look at the [OpenProject helm chart](../helm-chart).
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The respective sections explain everything you need to know.
To make things easier here we give further instructions on how to get up and running with OpenProject
on different platforms which use either the docker container or the package:

* [Kubernetes](../kubernetes)
* [Kubernetes using the OpenProject Helm chart](../helm-chart)
* [Synology](../synology)
* [Manual (not recommended)](../manual)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_navigation: false
# Synology

Synology offers NAS devices that come with a UI for starting docker containers on them.
This means OpenProject has to be used exactly as described in the [docker](../docker/#one-container-per-process-recommended) section.
This means OpenProject has to be used exactly as described in the [docker](../docker/) section.

## Launching the container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ sudo yum remove pgsql10

## Compose-based docker installation

> Please follow this section only if you have installed OpenProject using [this procedure](../../installation/docker/#one-container-per-process-recommended).
> Please follow this section only if you have installed OpenProject using [this procedure](../../installation/docker/).
> Before attempting the upgrade, please ensure you have performed a backup of your installation by following the [backup guide](../../operation/backing-up/).
You can find the upgrade instructions for your docker-compose setup in the [openproject-deploy](https://github.com/opf/openproject-deploy/blob/stable/14/compose/control/README.md#upgrade) repository.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ You may need to create the `files` directory if it doesn't exist yet.

#### 4) Start OpenProject

Start the container as described in the [installation section](../../installation/docker/#one-container-per-process-recommended)
Start the container as described in the [installation section](../../installation/docker/)
mounting `/var/lib/openproject/pgdata` (and `/var/lib/openproject/assets/` for attachments).

## Changing the database schema from cloud to on-premises
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ sudo chown -R 102 /volume1/openproject/*
```

After that it's simply a matter of launching the new container mounted with the copied `pgdata` and `assets` folders
as described in the [installation section](../../installation/docker/#one-container-per-process-recommended).
as described in the [installation section](../../installation/docker/).

## Upgrade notes from 9.x

Expand Down
Loading

0 comments on commit 1485df4

Please sign in to comment.