Clone this repository:
git clone https://github.com/opf/openproject-deploy --depth=1 --branch=stable/14 openproject
Go to the compose folder:
cd openproject/compose
Copy the example .env file and edit any values you want to change:
cp .env.example .env
vim .env
Make sure you are using the latest version of the Docker images and launch the containers:
docker compose pull
docker compose up -d
After a while, OpenProject should be up and running on http://localhost:8080.
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.
Be aware that if you want to use the integrated Caddy proxy as a proxy with outbound connections, you need to rewrite the
Caddyfile. In the default state, it is configured to forward the X-Forwarded-* headers from the reverse proxy in
front of it and not setting them itself. This is considered a security flaw and should instead be solved by configuring
trusted_proxies inside the Caddyfile. For more information read
the Caddy documentation.
By default the port is bound to 0.0.0.0 means access to OpenProject will be public.
See below how to change that.
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.
You can disable OpenProject’s HTTPS option via:
OPENPROJECT_HTTPS=false
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
If you want to specify a custom tag for the OpenProject docker image, you can do so with:
TAG=my-docker-tag
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
You can remove the stack with:
docker-compose down
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/.
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.
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