Skip to content

Commit

Permalink
amend local docs for https and port binding
Browse files Browse the repository at this point in the history
  • Loading branch information
machisuji authored and oliverguenther committed Oct 4, 2022
1 parent c793b35 commit 547e527
Showing 1 changed file with 50 additions and 6 deletions.
56 changes: 50 additions & 6 deletions compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,64 @@ Launch the containers:

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

## Configuration
**HTTPS/SSL**

If you want to specify a different port, you can do so with:
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](https://www.openproject.org/docs/installation-and-operations/installation/docker/#apache-reverse-proxy-setup).
Without this you will run into an `ERR_SSL_PROTOCOL_ERROR` when accessing OpenProject.

PORT=4000 docker-compose up -d
See below how to disable HTTPS.

If you want to specify a custom tag for the OpenProject docker image, you can do so with:
**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

TAG=my-docker-tag docker-compose up -d
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 also set those variables into an `.env` file in your current working
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:
Expand Down

0 comments on commit 547e527

Please sign in to comment.