dquadrant/kuber repository overview

⁠Kuber Server Docker Image

Kuber is a Haskell library and API server for composing balanced Cardano transactions. This Docker image provides a convenient way to run the Kuber server along with a Cardano node for quick setup and development.

⁠Useful Links

• GitHub Repository: https://github.com/dquadrant/kuber⁠
• Kuber Server API Reference: https://dquadrant.github.io/kuber/hydra_docusaurus/docs/kuber-api-reference⁠
• Transaction Builder JSON Reference: https://kuberide.com/kuber/docs/intro⁠
• Kuber Haskell Library Documentation: https://dquadrant.github.io/kuber/haskell_library/⁠
• Kuber Server README: https://github.com/dquadrant/kuber/blob/main/README.md⁠

⁠Using the Image

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

docker run -d \
  -p 8081:8081 \
  -e CARDANO_NODE_SOCKET_PATH=/ipc/node.socket \
  -e NETWORK=preprod \
  -v node-ipc:/ipc/node.socket \
  dquadrant/kuber:latest

• Replace /path/to/cardano-node/preprod/node.socket with the actual path to your Cardano node socket within the Docker container.
• Adjust NETWORK to mainnet, preview, preprod, sancho, or a network_magic number as needed.
• The API will be accessible at http://localhost:8081.

⁠Running with Docker Compose

For a quick setup, you can use the docker-compose.yml file provided in the root directory of the main repository to run Kuber Server along with a Cardano node.

1. Clone the Kuber repository:

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

   Copy

2. Start the services: Update the NETWORK environment variable in docker-compose.yml if necessary, then run the stack:

   docker-compose up -d
   

   Copy

   This command will start cardano-node and kuber in detached mode. You will have to wait for the Cardano node to sync to the latest block.

3. Verify services are running:

   docker-compose ps
   

   Copy

   Ensure all services are up and healthy.

4. Access the Kuber Server API: The API will be accessible at http://localhost:8081.