Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blinklabs-io/cardano-compose-stacks
Docker compose files for Cardano blockchain services
https://github.com/blinklabs-io/cardano-compose-stacks
cardano cardano-db-sync cardano-node docker-compose
Last synced: 4 days ago
JSON representation
Docker compose files for Cardano blockchain services
- Host: GitHub
- URL: https://github.com/blinklabs-io/cardano-compose-stacks
- Owner: blinklabs-io
- License: mit
- Created: 2023-09-12T15:05:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-09T19:37:59.000Z (27 days ago)
- Last Synced: 2024-06-10T18:24:52.408Z (26 days ago)
- Topics: cardano, cardano-db-sync, cardano-node, docker-compose
- Homepage:
- Size: 19.5 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Lists
- awesome-stars - blinklabs-io/cardano-compose-stacks - Docker compose files for Cardano blockchain services (Others)
README
# compose-stacks
This docker-compose setup provides a comprehensive environment for running Cardano related services. Below is a brief overview of the services and instructions on how to operate them.
## Services
- **cardano-node**: This is the main Cardano node service. It connects to the Cardano network specified by the NETWORK environment variable. By default, it connects to the `mainnet`.
- **cardano-node-api**: This service is responsible for interfacing with local Cardano node. It depends on the cardano-node service to be healthy before starting.
- **bursa**: This service is programatic wallet. It runs without any persistence.
- **ogmios**: This service is a lightweight bridge interface for cardano-node. It provides an HTTP / WebSocket API that enables applications to interact with a local cardano-node via JSON+RPC-2.0. It depends on the cardano-node service to be healthy before starting.
- **tx-submit-api**: This service is responsible for submitting transactions to the Cardano network. It depends on the cardano-node service to be healthy before starting.
- **cardano-db-sync**: This service syncs the Cardano blockchain data to a PostgreSQL database. It depends on both the cardano-node and postgres services to be healthy before starting.
- **postgres**: This is the PostgreSQL database service used by the cardano-db-sync service to store the Cardano blockchain data.
## How to Start Services
Because each service has defined dependency that means starting a service will also start it's dependencies.
### Start Just the Cardano Node
To start only the cardano-node service, run:
```bash
docker compose up cardano-node
```
### Start Cardano Node and cardano-node-api
To start both the cardano-node and cardano-node-api services, run:
```bash
docker compose up cardano-node-api
```
### Start Cardano Node and tx-submit-api
To start both the cardano-node and tx-submit-api services, run:
```bash
docker compose up tx-submit-api
```
### Start Cardano Node and db-sync
To start both the cardano-node, cardano-db-sync and postgres services, run:
```bash
docker compose up cardano-db-sync
```
## How to Start All Services in Detached Mode
To start all services defined in the docker-compose file in detached mode, simply run:
```bash
docker compose up -d
```
This command will start all the services (i.e., cardano-node, tx-submit-api, cardano-db-sync, and postgres) in the background.
If you need to stop the services later, you can use:
```bash
docker compose down
```
This will stop and remove all the services started with docker-compose up. If you've started specific services and want to stop them, you can specify them in the down command, similar to the up command.
## How to use Bursa
To start just the bursa service, run:
```bash
docker compose up bursa
```
**Access Swagger UI:**
Open your web browser and navigate to the Swagger UI:
**Execute a Create Request using Swagger UI:**
- In the Swagger UI, find the section for creating a new wallet.
- Click on the `Get` `/api/v1/wallet/create` operation.
- Choose `Try it out`.
- Click `Execute`.
This will send a create request to Bursa and you should receive a JSON response with the details of the newly created wallet.
Store mnemonic in a safe place. If you want to restore the wallet, you will need the mnemonic. If you lose the mnemonic, you will lose access to the wallet.