{"id":27801506,"url":"https://github.com/ergoplatform/ergo-bootstrap","last_synced_at":"2026-01-06T12:55:53.678Z","repository":{"id":46190578,"uuid":"315033265","full_name":"ergoplatform/ergo-bootstrap","owner":"ergoplatform","description":"Ergo bootstrap tool, built on top of ergo-nix, will help you to quickly deploy an Ergo blockchain cluster with a handful of useful tools you might need to start developing your dApps.","archived":false,"fork":false,"pushed_at":"2022-07-19T05:47:53.000Z","size":29,"stargazers_count":9,"open_issues_count":8,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-04-19T17:17:26.026Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ergoplatform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-22T12:33:58.000Z","updated_at":"2022-08-21T07:40:20.000Z","dependencies_parsed_at":"2022-08-29T18:51:56.525Z","dependency_job_id":null,"html_url":"https://github.com/ergoplatform/ergo-bootstrap","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergoplatform%2Fergo-bootstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergoplatform%2Fergo-bootstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergoplatform%2Fergo-bootstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ergoplatform%2Fergo-bootstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ergoplatform","download_url":"https://codeload.github.com/ergoplatform/ergo-bootstrap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251825376,"owners_count":21649941,"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":[],"created_at":"2025-05-01T05:01:17.454Z","updated_at":"2026-01-06T12:55:53.651Z","avatar_url":"https://github.com/ergoplatform.png","language":"Shell","funding_links":[],"categories":["🛠️ Development Tooling \u003ca id=\"development-tooling\"\u003e\u003c/a\u003e"],"sub_categories":["⌨️ CLI Tools \u003ca id=\"cli-tools\"\u003e\u003c/a\u003e"],"readme":"\u003cimg src=\".github/ergo-bootstrap.svg\" align=\"right\" height=\"100\" /\u003e\n\n# Ergo Bootstrap\n\nErgo bootstrap tool, build on top of [ergo-nix](https://github.com/ergoplatform/ergo-nix), will help you to quickly deploy an Ergo blockchain cluster with a handful of useful tools you might need to start developing your dApps.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#key-features\"\u003eKey Features\u003c/a\u003e •\n  \u003ca href=\"#Installation\"\u003eInstallation\u003c/a\u003e •\n  \u003ca href=\"#usage\"\u003eHow To Use\u003c/a\u003e •\n  \u003ca href=\"#support\"\u003eSupport\u003c/a\u003e •\n  \u003ca href=\"#credits\"\u003eCredits\u003c/a\u003e\n\u003c/p\u003e\n\n## Key Features\n\n* Ergo node, a full blockchain node, the reference client implementation.\n* Ergo backends\n  * Explorer API, provides a set of HTTP API methods for querying chain/off-chain data.\n  * UTX watcher, dumps unconfirmed transactions from mempool to local database.\n  * UTX broadcaster, broadcasts unconfirmed transactions to Ergo nodes.\n  * Chain grabber, scans blockchain and dumps aggregated data to database.\n  * Yoroi backend, a wrapper for the Ergo explorer API providing light wallets endpoints.\n* Ergo frontends\n  * Ergo node panel, build-in\n  * Ergo explorer, a browser for viewing activity on the underlying blockchain network.\n\n## Installation\n\nThe bootstrap cluster is supposed to be a development tool and we do not recommend using it as a production deployment. \n\nYou need to have `docker` and `docker-compose` installed on your system. We recommend at least 8GB of memory.\n\n```bash\n# Clone this repository\n$ git clone https://github.com/ergoplatform/ergo-bootstrap\n\n# Go into the repository\n$ cd ergo-bootstrap\n\n# Run the bootstrap script\n$ ./ergo-bootstrap\nUsage: ./ergo-bootstrap {init|start|stop|status|destroy}\n\n    init      Initialize a ergo bootstrap cluster\n    start     Start the cluster\n    stop      Stop the cluster\n    status    Get status of an initialized cluster\n    destroy   Destroy the current cluster\n```\n\n## Usage\n\n### Initializing your cluster\n\n![Ergo bootstrap init](.github/ergo-bootstrap-init.svg)\n\n### Starting and stopping your cluster\n\nUse the `start` and `stop` commands.\n\n```\n$ ./ergo-bootstrap stop\nStopping ergo-bootstrap_ergo-explorer-api_1                   ... done\n$\n```\n\n### Status of the cluster\n\nYou can view the current status of your cluster using the `status` command.\n\n```\n$ ./ergo-bootstrap status\nNAMES                                 CONTAINER ID      STATUS            PORTS\nergo-bootstrap_yoroi-backend_1        c5db1d6f2795      Up 35 minutes     0.0.0.0:3001-\u003e3001/tcp\nergo-bootstrap_ergo-explorer-api_1    20d17f44e95a      Up 35 minutes     0.0.0.0:8080-\u003e8080/tcp\nergo-bootstrap_ergo-postgresql_1      c9ef2a3cdfa4      Up 35 minutes     5432/tcp\nergo-bootstrap_ergo-redis_1           a7ea3d025cc5      Up 35 minutes     6379/tcp\n                                              ...\n\nErgo Node Panel                    http://localhost:9053/panel/\nErgo Node API                      http://localhost:9053/\nYoroi backed API                   http://localhost:3001/api/v2/bestblock\nGrafana metrics                    http://localhost:3000/ (user admin / password admin)\n```\n\n## Support\n\nIf you find a bug or have a feature you would like to see, [please open an issue](https://github.com/ergoplatform/ergo-bootstrap/issues/new). For help, join the [Ergo Platform Discord server](https://discordapp.com/invite/gYrVrjS).\n\n## Credits\n\nThis project has [been sponsored by a grant from The Ergo Foundation](https://ergoplatform.org/en/blog/2020-11-18-ergo-foundation-makes-key-dapp-infrastructure-grant/). Ergo is a community-oriented project, with many contributors to various aspects of the ecosystem. If you have a great idea which you are looking to implement that would improve the Ergo ecosystem as a whole, please feel free to apply for an Ergo Foundation grant by emailing your proposal to: ergoplatform@protonmail.com.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fergoplatform%2Fergo-bootstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fergoplatform%2Fergo-bootstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fergoplatform%2Fergo-bootstrap/lists"}