Skip to content

Commit

Permalink
docs: fix readme startup instructions (#204)
Browse files Browse the repository at this point in the history
Updates readme instructions for running via docker and mounting the config directory.

Fixes #203
  • Loading branch information
SgtPooki authored Oct 29, 2024
1 parent e5e0f27 commit 9d0618f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,19 +149,25 @@ $ docker build . --tag amino
### Running the docker image (once built):

```sh
$ docker run -v $(pwd)/bootstrapper-config.json:/config.json -it amino --config /config.json
$ docker run -it amino
```

By default, the config file is stored at `$HOME/.config/@libp2p/amino-dht-bootstrapper/config.json`. You can mount this file into the container by running:

```sh
$ docker run -v $HOME/.config/@libp2p/amino-dht-bootstrapper/:/root/.config/@libp2p/amino-dht-bootstrapper/ -it amino
```

To pass args:

```sh
$ docker run -v $(pwd)/bootstrapper-config.json:/config.json -it amino --config /config.json [--enable-kademlia] [--enable-autonat]
$ docker run -it amino [--enable-kademlia] [--enable-autonat]
```

To expose the metrics port:

```sh
$ docker run -v $(pwd)/bootstrapper-config.json:/config.json -p 8888:8888 -it amino --config /config.json
$ docker run -p 8888:8888 -it amino
```

### Running the docker image with monitoring:
Expand Down

0 comments on commit 9d0618f

Please sign in to comment.