Skip to content

Commit

Permalink
Update docker readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
evan-buss committed Jan 22, 2021
1 parent 9a2ea33 commit 94ebe85
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docker.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,32 @@
# OpenBooks Docker Image

> See [Github](https://github.com/evan-buss/openbooks) for more information.
## Usage

### Basic

`docker run -d -p 8080:80 openbooks`
`docker run -d -p 8080:80 evanbuss/openbooks`

### Persist eBook Files

`docker run -d -p 8080 -v ~/Downloads:/books openbooks -persist`
`docker run -d -p 8080 -v ~/Downloads:/books evanbuss/openbooks --persist`

### Set custom IRC name (default random adjective-username combination)
### Set custom IRC name (default is a random 'adjective-noun' combination)

`docker run -d -p 8080:80 openbooks -name my_irc_name`
`docker run -d -p 8080:80 evanbuss/openbooks --name my_irc_name`

## Arguments

```
-name string
--name string
Use a custom name when connecting to irchighway
-persist
--persist
Keep book files in the download dir. Default is to delete after sending.
```

## Docker Compose

```docker
version: '3.3'
services:
Expand All @@ -34,10 +37,9 @@ services:
- 'booksVolume:/books'
restart: unless-stopped
container_name: OpenBooks
command: -persist
command: --persist
image: evan-buss/openbooks:latest
volumes:
booksVolume:
```

0 comments on commit 94ebe85

Please sign in to comment.