Skip to content

Commit b69cf9f

Browse files
committed
Improve getting started section
1 parent b9df970 commit b69cf9f

File tree

2 files changed

+27
-41
lines changed

2 files changed

+27
-41
lines changed

docs/docs/hydra-js-client/getting-started.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,24 @@ In our example setup:
2222

2323
You can run `kuber-hydra` either directly or using Docker.
2424

25-
#### **Option 1: Running Natively**
25+
#### **With cabal**
2626

27-
To run `kuber-hydra` natively, you need to set the required environment variables and then run the application using `cabal`.
27+
To run `kuber-hydra` with cabal, you need to set the required environment variables and then run the application.
2828

29-
1. **Set Environment Variables (Required):**
30-
Before running, you must set the following environment variables:
31-
```bash
32-
export CARDANO_NODE_SOCKET_PATH=/path/to/cardano-node/preview/node.socket
33-
export NETWORK=2
34-
```
35-
- `CARDANO_NODE_SOCKET_PATH`: The path to your Cardano node socket.
36-
- `NETWORK`: The Cardano network ID (e.g., `2` for Preview testnet). This is a **required** environment variable.
37-
38-
2. **Run `kuber-hydra`:**
39-
Navigate to the `kuber-hydra` directory and run the application using `cabal`:
40-
```bash
41-
cd kuber-hydra
42-
cabal run kuber-hydra -- --hydra-url ws://172.16.238.10:4001 --port 8081
43-
```
44-
- `--hydra-url`: The WebSocket URL of your Hydra node. This is a **required** command-line argument.
45-
- `--port`: The port for the Kuber-Hydra relay server. If not specified, it defaults to `8081`.
29+
```bash
30+
export CARDANO_NODE_SOCKET_PATH=/path/to/cardano-node/preview/node.socket
31+
export NETWORK=preview
32+
cd kuber-hydra
33+
cabal run kuber-hydra -- --hydra-url ws://172.16.238.10:4001 --port 8081
34+
```
35+
- `CARDANO_NODE_SOCKET_PATH`: The path to your Cardano node socket.
36+
- `NETWORK`: The Cardano network ID (e.g., `mainnet`, `preview`, `preprod`, or a `network_magic` number). This is a **required** environment variable.
37+
- `--hydra-url`: The WebSocket URL of your Hydra node. This is a **required** command-line argument.
38+
- `--port`: The port for the Kuber-Hydra relay server. If not specified, it defaults to `8081`.
4639

4740
> The Kuber-Hydra relay API will be accessible at `http://localhost:8081`.
4841
49-
#### **Option 2: Running with Docker (Recommended for quick setup)**
42+
#### **With Docker**
5043

5144
For a quick setup, you can use the provided `docker-compose.yml` to run `kuber-hydra` along with a Cardano node and Hydra node.
5245

kuber-hydra/README.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,20 @@
66

77
## Running Kuber-Hydra
88

9-
### Natively
10-
11-
To run `kuber-hydra` natively, you need to set the required environment variables and then run the application using `cabal`.
12-
13-
1. **Set Environment Variables (Required):**
14-
Before running, you must set the following environment variables:
15-
```bash
16-
export CARDANO_NODE_SOCKET_PATH=/path/to/cardano-node/preview/node.socket
17-
export NETWORK=2
18-
```
19-
- `CARDANO_NODE_SOCKET_PATH`: The path to your Cardano node socket.
20-
- `NETWORK`: The Cardano network ID (e.g., `2` for Preview testnet). This is a **required** environment variable.
21-
22-
2. **Run `kuber-hydra`:**
23-
Navigate to the `kuber-hydra` directory and run the application using `cabal`:
24-
```bash
25-
cd kuber-hydra
26-
cabal run kuber-hydra -- --hydra-url ws://172.16.238.10:4001 --port 8081
27-
```
28-
- `--hydra-url`: The WebSocket URL of your Hydra node. This is a **required** command-line argument.
29-
- `--port`: The port for the Kuber-Hydra relay server. If not specified, it defaults to `8081`.
9+
### With cabal
10+
11+
To run `kuber-hydra` with cabal, you need to set the required environment variables and then run the application.
12+
13+
```bash
14+
export CARDANO_NODE_SOCKET_PATH=/path/to/cardano-node/preview/node.socket
15+
export NETWORK=preview
16+
cd kuber-hydra
17+
cabal run kuber-hydra -- --hydra-url ws://172.16.238.10:4001 --port 8081
18+
```
19+
- `CARDANO_NODE_SOCKET_PATH`: The path to your Cardano node socket.
20+
- `NETWORK`: The Cardano network ID (e.g., `mainnet`, `preview`, `preprod`, or a `network_magic` number). This is a **required** environment variable.
21+
- `--hydra-url`: The WebSocket URL of your Hydra node. This is a **required** command-line argument.
22+
- `--port`: The port for the Kuber-Hydra relay server. If not specified, it defaults to `8081`.
3023

3124
### With Docker
3225

0 commit comments

Comments
 (0)