Skip to content

Commit

Permalink
docs: update README (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
duncanleo committed Jun 15, 2024
1 parent e3f8e99 commit 75f2c31
Showing 1 changed file with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,35 @@ This web server emulates a SiliconDust HDHomeRun by its HTTP API for use with Pl

### Running
##### Docker
A Docker container is available for use. Do take note of the need for `config.json` and `channels.json`.
A prebuilt [Docker image](https://github.com/duncanleo/plex-dvr-hls/pkgs/container/plex-dvr-hls) is available for use.

###### Supported Architectures
- `linux/amd64`
- `linux/arm64`
- `linux/arm/v7`

###### Docker Compose
Please refer to the [sample Docker Compose file](./docker-compose.yml) for a more seamless setup.

Please note that the following files need to be present in the same directory (see examples in the repository).
- `config.json`
- `channels.json`

```yaml
services:
plex-dvr-hls:
image: ghcr.io/duncanleo/plex-dvr-hls:latest
volumes:
- './config.json:/app/config.json:ro'
- './channels.json:/app/channels.json:ro'
- './templates:/app/templates:ro'
ports:
- '5004:5004'
plex-dvr-hls:
image: ghcr.io/duncanleo/plex-dvr-hls:latest
volumes:
- type: bind
source: './config.json'
target: '/app/config.json'
read_only: true
- type: bind
source: './channels.json'
target: '/app/channels.json'
read_only: true
ports:
- '5004:5004'
```
##### Binary
Expand Down

0 comments on commit 75f2c31

Please sign in to comment.