Skip to content

Commit

Permalink
added compose example
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippMundhenk committed Aug 3, 2023
1 parent 29d446c commit 018134c
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ You can configure the tool via environment variables. The following are required
| MODEL | Model of your scanner (see Supported Models) |
| IPADDRESS | IP Address of your scanner |

### Docker example
'''
### Docker Example
```
docker run \
-d \
-v "/home/$USER/scans:/scans" \
Expand All @@ -27,7 +27,24 @@ docker run \
-e IPADDRESS="10.0.0.1" \
--net=host \
ghcr.io/philippmundhenk/brotherscannerdocker:master
'''
```

### Docker Compose Example
```yaml
version: '3'

services:
brother-scanner:
image: ghcr.io/philippmundhenk/brotherscannerdocker:master
volumes:
- /var/docker/brotherscanner/scans:/scans
environment:
- NAME=Scanner
- MODEL=MFC-L2700DW
- IPADRESS=192.168.44.26
restart: unless-stopped
network_mode: "host"
```
## Customize
As the standard scripts are not working particularly well, you may customize them to your needs.
Expand Down

0 comments on commit 018134c

Please sign in to comment.