Skip to content

Latest commit

 

History

History
 
 

compose

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

OpenProject installation with Docker Compose

Install

Clone this repository:

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

Go to the compose folder:

cd openproject/compose

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

docker-compose pull

Copy the example .env file and edit any values you want to change:

cp .env.example .env
vim .env

Launch the containers:

docker-compose up -d

After a while, OpenProject should be up and running on http://localhost:8080.

HTTPS/SSL

By default OpenProject starts with the HTTPS option enabled, but it does not handle SSL termination itself. This is usually done separately via a reverse proxy setup. Without this you will run into an ERR_SSL_PROTOCOL_ERROR when accessing OpenProject.

See below how to disable HTTPS.

PORT

By default the port is bound to 0.0.0.0 means access to OpenProject will be public. See below how to change that.

Configuration

Environment variables can be added to docker-compose.yml under x-op-app -> environment to change OpenProject's configuration. Some are already defined and can be changed via the environment.

You can pass those variables directly when starting the stack as follows.

VARIABLE=value docker-compose up -d

You can also put those variables into an .env file in your current working directory, and Docker Compose will pick it up automatically. See .env.example for details.

HTTPS

You can disable OpenProject's HTTPS option via:

OPENPROJECT_HTTPS=false

PORT

If you want to specify a different port, you can do so with:

PORT=4000

If you don't want OpenProject to bind to 0.0.0.0 you can bind it to localhost only like this:

PORT=127.0.0.1:8080

TAG

If you want to specify a custom tag for the OpenProject docker image, you can do so with:

TAG=my-docker-tag

Upgrade

Go to the compose folder:

cd openproject/compose

Retrieve any changes from the openproject-deploy repository:

git pull origin stable/12

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

docker-compose pull

Relaunch the containers:

docker-compose up -d

Uninstall

You can remove the stack with:

docker-compose down

Troubleshooting

You can look at the logs with:

docker-compose logs -n 1000

For the complete documentation, please refer to https://docs.openproject.org/installation-and-operations/.

Network issues

If you're running into weird network issues and timeouts such as the one described in OP#42802, you might have success in remove the two separate frontend and backend networks. This might be connected to using podman for orchestration, although we haven't been able to confirm this.

SMTP setup fails: Network is unreachable.

Make sure your container has DNS resolution to access external SMTP server when set up as described in OP#44515.

worker:
   dns:    
     - "Your DNS IP" # OR add a public DNS resolver like 8.8.8.8