Skip to content

Commit 26cb4bb

Browse files
committed
chore: update README to give usage
Signed-off-by: Chris Gianelloni <[email protected]>
1 parent a111ceb commit 26cb4bb

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# docker-cardano-db-sync
2-
Builds a cardano-db-sync on debian
2+
Builds a Cardano DB sync container from source on Debian. This image attempts
3+
to keep interface compatibility with `inputoutput/cardano-db-sync`, but may
4+
diverge slightly, particularly with any Nix-specific paths.
5+
6+
## Running
7+
To run a Cardano DB sync on mainnet, attached to a local Cardano full node
8+
container running:
9+
```bash
10+
docker run --detach \
11+
--name cardano-db-sync \
12+
-v dbsync-state:/var/lib/cexplorer \
13+
-v node-ipc:/node-ipc \
14+
ghcr.io/cloudstruct/cardano-db-sync
15+
```
16+
17+
DB sync logs can be followed:
18+
```bash
19+
docker logs -f cardano-db-sync
20+
```

0 commit comments

Comments
 (0)