From 682e14f0c8277eee09ae4829f8f927ecc83ffced Mon Sep 17 00:00:00 2001 From: FLYBYME Date: Thu, 23 Jan 2025 14:34:46 -0600 Subject: [PATCH] feat(README.md): add installation instructions for running services with Docker and NATS transporter --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index fbca45d..4885a0b 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,20 @@ These services require the following services to be running: - [Config-service](https://github.com/FLYBYME/config-service) - [Nodes-service](https://github.com/FLYBYME/nodes-service) +## Installation + +To run the services, install Docker and run the following command: +```bash +docker run -d --name block-storage --restart always -v /path/to/data:/app/db ghcr.io/flybyme/block-storage:main +``` +For Nats as the transporter + +```bash +docker run -d --name block-storage --restart always -e TRANSPORTER=nats://10.1.10.1:4222 -v /path/to/data:/app/db ghcr.io/flybyme/block-storage:main +``` + +Replace `/path/to/data` with the path to your data directory. + ## Index