dquadrant/kuber-hydra repository overview

⁠Kuber Hydra Docker Image

Kuber Hydra facilitates interaction with a Hydra Head on the Cardano blockchain. This Docker image provides a convenient way to run Kuber Hydra along with a Cardano node and Hydra node for quick setup and development, and in production setup.

⁠Useful Links

• GitHub Repository: https://github.com/dquadrant/kuber⁠
• Documentation: https://dquadrant.github.io/kuber/hydra_docusaurus/docs/hydra-js-client/getting-started⁠
• Kuber Hydra README: https://github.com/dquadrant/kuber/blob/master/kuber-hydra/README.md⁠

⁠Using the Image

You can run the Kuber-Hydra Docker image directly using docker run. This assumes you have a running Cardano node and Hydra node accessible from your Docker environment.

docker run -d \
  -p 8081:8081 \
  -v node-ipc:/ipc/node.socket # mount the node's ipc correctly. 
  -e CARDANO_NODE_SOCKET_PATH=/ipc/node.socket \
  -e NETWORK=preview \
  dquadrant/kuber-hydra:latest \
  --hydra-url ws://172.16.238.10:4001 \

• Replace /path/to/cardano-node/preview/node.socket with the actual path to your Cardano node socket within the Docker container.
• Adjust NETWORK to mainnet, preview, preprod, or a network_magic number as needed.
• Adjust --hydra-url to the WebSocket URL of your Hydra node.

⁠Running with Docker Compose

For a quick setup, you can use the docker-compose.yml file provided in the kuber-hydra directory of the main repository to run kuber-hydra along with a Cardano node and Hydra node.

1. Clone the Kuber repository:

   git clone https://github.com/dquadrant/kuber.git
   cd kuber
   

   Copy

2. Navigate to the kuber-hydra directory:

   cd kuber-hydra
   

   Copy

3. Start the services: Update the hydra-node configuration in docker-compose.yml if necessary, then run the stack:

   docker-compose up -d
   

   Copy

   This command will start cardano-node, hydra-node, and kuber-hydra in detached mode.

4. Verify services are running:

   docker-compose ps
   

   Copy

   Ensure all services are up and healthy.

5. Access the Kuber-Hydra Relay API: The API will be accessible at http://localhost:8081.