Skip to content

Commit

Permalink
chore: clean up getting started wording in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mootz12 committed Oct 8, 2024
1 parent 0a742dd commit 4d8fdba
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ It is recommended to run the auctioneer bot as a docker container. The image can
docker pull script3/auctioneer-bot:latest
```

To run the container, you will need to provide a volume mount from the host to `/app/data` with a config file named `config.json` at the root of the volume. Please see [Configuration](#configuration) for documentation of the configuration file.
To run the container, you will need to mount a directory from the host to `/app/data` on the container. The directory must contain a config file named `config.json` at its root. Please see [Configuration](#configuration) for details on the configuration file.

The container will create a sqlite3 database that tracks bot activity and log files outputted by the bot in the mounted volume.
The container will create a sqlite3 database that tracks bot activity and log files in the mounted directory.

Use the following command to run the container:
```bash
docker run --restart always -d -v /path/on/host:/app/data script3/auctioneer-bot:latest
```
Expand Down

0 comments on commit 4d8fdba

Please sign in to comment.