{"id":13476671,"url":"https://github.com/blinklabs-io/cardano-compose-stacks","last_synced_at":"2025-04-30T17:27:19.470Z","repository":{"id":195052314,"uuid":"690632556","full_name":"blinklabs-io/cardano-compose-stacks","owner":"blinklabs-io","description":"Docker compose files for Cardano blockchain services","archived":false,"fork":false,"pushed_at":"2025-04-10T15:43:20.000Z","size":108,"stargazers_count":8,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T16:55:08.926Z","etag":null,"topics":["cardano","cardano-db-sync","cardano-node","docker-compose"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blinklabs-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-09-12T15:05:50.000Z","updated_at":"2025-04-10T15:43:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"a318071a-2c9c-4a57-8cb8-b977b765dd3d","html_url":"https://github.com/blinklabs-io/cardano-compose-stacks","commit_stats":{"total_commits":56,"total_committers":3,"mean_commits":"18.666666666666668","dds":0.125,"last_synced_commit":"b8897df9e0de6c817cd67b3f451e84176063bcfe"},"previous_names":["blinklabs-io/compose-stacks","blinklabs-io/cardano-compose-stacks"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fcardano-compose-stacks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fcardano-compose-stacks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fcardano-compose-stacks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fcardano-compose-stacks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blinklabs-io","download_url":"https://codeload.github.com/blinklabs-io/cardano-compose-stacks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251750515,"owners_count":21637739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cardano","cardano-db-sync","cardano-node","docker-compose"],"created_at":"2024-07-31T16:01:33.214Z","updated_at":"2025-04-30T17:27:19.457Z","avatar_url":"https://github.com/blinklabs-io.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# compose-stacks\n\nThis 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.\n\n## Services\n\n- **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`.\n\n- **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.\n\n- **bursa**: This service is programatic wallet. It runs without any persistence.\n\n- **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.\n\n- **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.\n\n- **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.\n\n- **postgres**: This is the PostgreSQL database service used by the cardano-db-sync service to store the Cardano blockchain data.\n\n## How to Start Services\n\nBecause each service has defined dependency that means starting a service will also start it's dependencies.\n\n### Using Profiles in Docker Compose\n\nWith profiles, you can selectively start services based on different needs or environments.\nBelow are examples of how to use profiles in this setup.\n\n### Start Just the Cardano Node\n\nTo start only the `cardano-node` service, which is part of the `node` profile, run:\n\n```bash\ndocker compose --profile node up\n```\n\n### Start Cardano Node and cardano-node-api\n\nTo start both the `cardano-node` and `cardano-node-api` use `node-api` profile, run:\n\n```bash\ndocker compose --profile node-api up\n```\n\n### Start Cardano Node and tx-submit-api\n\nTo start both the `cardano-node` and `tx-submit-api` use `tx-submit-api` profile, run:\n\n```bash\ndocker compose --profile tx-submit-api up\n```\n\n### Start Cardano Node and db-sync\n\nTo start both the `cardano-node` and `cardano-db-sync` use `db-sync` profile, run:\n\n```bash\ndocker compose --profile db-sync up\n```\n\n### Start All Services in Detached Mode\n\nTo start all services defined in the `docker-compose.yml` file in detached mode, run:\n\ndocker compose up -d\n\nThis command will start all services (e.g., `cardano-node`, `tx-submit-api`, `cardano-db-sync`, and `postgres`) in the background, regardless of profiles.\nIf you need to stop the services later, use:\n\ndocker compose down\n\nThis will stop and remove all the services started with `docker compose up`.\nIf you've started specific services using profiles and want to stop them, you can specify the same profiles in the `down` command.\n\n### How to Use Bursa\n\nTo start just the `bursa` service, which is part of the `bursa` profile, run:\n\n```bash\ndocker compose --profile bursa up\n```\n\n**Access Swagger UI:**\n\nOpen your web browser and navigate to the Swagger UI:\n\n\u003chttp://localhost:8090/swagger/index.html\u003e\n\n**Execute a Create Request using Swagger UI:**\n\nIn the Swagger UI, find the section for creating a new wallet.\nClick on the `Get` `/api/v1/wallet/create` operation.\nChoose `Try it out`.\nClick `Execute`.\n\nThis will send a create request to Bursa, and you should receive a JSON response with the details of the newly created wallet.\n\nStore the 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.\n\n### How to Use Bluefin\n\nTo start just the `bluefin` service, which is part of the `bluefin` profile, run:\n\n```bash\ndocker compose --profile bluefin up\n```\n\nto start the `bluefin-inspector` service, which is part of the `bluefin-inspector` profile, run:\n\n```bash\ndocker compose --profile bluefin-inspector up\n```\n\nto start both the `bluefin` and `bluefin-inspector` services, use `bluefin` and `bluefin-inspector` profile, run:\n\n```bash\ndocker compose --profile bluefin --profile bluefin-inspector up\n```\n\nto see the seed phrase of the wallet created by bluefin, run:\n\n```bash\n docker exec bluefin-inspector cat /data/seed.txt\n```\n\nBluefin-inspector is a service that will allow you to see the seed phrase of the wallet created by bluefin.\nSeed phrase will be stored and managed on the local filesystem of the Docker host.\nThe bluefin-inspector is setup to run for an 1h. After that, it will stop automatically.\n\nYou can restart it by running the command below.\n\n```bash\ndocker compose --profile bluefin-inspector up -d --force-recreate\n```\n\n### How to Use Cardano Wallet\n\nTo start just the `cardano-wallet` service, which is part of the `wallet` profile, run:\n\n```bash\ndocker compose --profile wallet up\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblinklabs-io%2Fcardano-compose-stacks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblinklabs-io%2Fcardano-compose-stacks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblinklabs-io%2Fcardano-compose-stacks/lists"}