Skip to content

Commit

Permalink
docs: Fix docker compose example in readme (fix #172)
Browse files Browse the repository at this point in the history
Signed-off-by: Julius Knorr <[email protected]>
  • Loading branch information
juliushaertl committed Oct 9, 2024
1 parent fdba6ff commit 707a45a
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ occ config:app:set whiteboard collabBackendUrl --value="http://nextcloud.local:3
occ config:app:set whiteboard jwt_secret_key --value="some-random"
```

### Running the server

#### Local node

This mode requires at least Node 20 and NPM 10 to be installed. You can clone this repository, checkout the release version matching your whiteboard app.
Expand All @@ -49,22 +51,12 @@ JWT_SECRET_KEY="some-random" NEXTCLOUD_URL=http://nextcloud.local npm run server

#### Docker

### Building the image

The image can be built using the following command:

```bash
docker build -t nextcloud-whiteboard-server
```

### Running the server

The server requires the `NEXTCLOUD_URL` environment variable to be set to the URL of the Nextcloud instance that the Whiteboard app is installed on. The server will connect to the Nextcloud instance and listen for whiteboard events.

The server can be run in a container using the following command:

```bash
docker run -e JWT_SECRET_KEY=some-random -e NEXTCLOUD_URL=https://nextcloud.local --restart unless-stopped -d ghcr.io/nextcloud-releases/whiteboard:release
docker run -e JWT_SECRET_KEY=some-random -e NEXTCLOUD_URL=https://nextcloud.local --rm ghcr.io/nextcloud-releases/whiteboard:release
```

Docker compose can also be used to run the server:
Expand All @@ -76,13 +68,20 @@ services:
image: ghcr.io/nextcloud-releases/whiteboard:release
ports:
- 3002:3002
environment:
environment:
- NEXTCLOUD_URL=https://nextcloud.local
- JWT_SECRET_KEY=some-random-key

```
#### Building the image locally
While we publish image on the GitHub container registry you can build the image locally using the following command:
```bash
docker build -t nextcloud-whiteboard-server -f Dockerfile .
```

### Reverse proxy

#### Apache
Expand Down

0 comments on commit 707a45a

Please sign in to comment.