Skip to content

Commit 010497b

Browse files
committed
docker setup instructions
1 parent cea0c1d commit 010497b

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

Diff for: README.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,43 @@
55
## Required Dependencies
66

77
* `nodejs` and `npm` (Latest LTS, v18 minimum supported)
8-
* Synced [HAF](https://gitlab.syncad.com/hive/haf) node
8+
* Synced [HAF](https://gitlab.syncad.com/hive/haf) node, ideally using [`haf_api_node`](https://gitlab.syncad.com/hive/haf_api_node) compose
9+
10+
## Docker Setup
11+
12+
This assumes HAF is running through [`haf_api_node`](https://gitlab.syncad.com/hive/haf_api_node).
13+
14+
Clone this repository, then add the following in the `.env` file in `haf_api_node` directory:
15+
16+
```env
17+
COMPOSE_FILE="${COMPOSE_FILE}:/path/to/vsc-haf/repo/docker/compose.yml"
18+
VSC_HAF_VERSION=latest
19+
VSC_HAF_GITHUB_API_KEY=YOUR_OPTIONAL_GITHUB_API_KEY
20+
VSC_HAF_IPFS_API_URL=http://YOUR_IPFS_URL:5001
21+
VSC_HAF_SUBINDEXER_LOG_LEVEL=info
22+
```
23+
24+
Build the Docker image:
25+
26+
```sh
27+
cd /path/to/vsc-haf/repo
28+
./scripts/build_instance.sh
29+
```
30+
31+
Run the HAF app sync:
32+
```sh
33+
docker compose up -d vsc-haf-block-processing
34+
```
35+
36+
Run the subindexer (IPFS daemon must be already running):
37+
```sh
38+
docker compose up -d vsc-haf-subindexer
39+
```
40+
41+
Run the PostgREST server:
42+
```sh
43+
docker compose up -d vsc-haf-postgrest
44+
```
945

1046
## Setup
1147

0 commit comments

Comments
 (0)