{"id":24042108,"url":"https://github.com/hyperledger-cello/cello","last_synced_at":"2025-05-14T14:08:04.021Z","repository":{"id":37663242,"uuid":"78610786","full_name":"hyperledger-cello/cello","owner":"hyperledger-cello","description":"Operating System for Enterprise Blockchain","archived":false,"fork":false,"pushed_at":"2025-05-13T18:44:58.000Z","size":118084,"stargazers_count":903,"open_issues_count":26,"forks_count":448,"subscribers_count":69,"default_branch":"main","last_synced_at":"2025-05-13T19:52:42.337Z","etag":null,"topics":["blockchain","distributed-ledger","hyperledger","operating-system"],"latest_commit_sha":null,"homepage":"https://wiki.hyperledger.org/display/cello","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger-cello.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-01-11T06:47:08.000Z","updated_at":"2025-05-13T18:54:59.000Z","dependencies_parsed_at":"2023-10-20T20:17:23.441Z","dependency_job_id":"3c38806a-2293-48ad-93bf-aa86fccf08ae","html_url":"https://github.com/hyperledger-cello/cello","commit_stats":{"total_commits":959,"total_committers":74,"mean_commits":12.95945945945946,"dds":0.7789363920750783,"last_synced_commit":"faca4b9a7d5de448a7bf733d2d304558f6b31902"},"previous_names":["hyperledger-cello/cello","hyperledger/cello"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-cello%2Fcello","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-cello%2Fcello/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-cello%2Fcello/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-cello%2Fcello/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger-cello","download_url":"https://codeload.github.com/hyperledger-cello/cello/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254159642,"owners_count":22024562,"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":["blockchain","distributed-ledger","hyperledger","operating-system"],"created_at":"2025-01-08T22:17:49.500Z","updated_at":"2025-05-14T14:08:04.014Z","avatar_url":"https://github.com/hyperledger-cello.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"![Cello](docs/images/favicon.png)\n\n[![Release](https://img.shields.io/github/v/release/hyperledger-cello/cello)](https://github.com/hyperledger-cello/cello/releases)\n[![Build Status](https://github.com/hyperledger/cello/actions/workflows/docker-image.yml/badge.svg)](https://github.com/hyperledger/cello/actions/workflows/docker-image.yml)\n[![License](https://img.shields.io/github/license/hyperledger-cello/cello)](https://github.com/hyperledger-cello/cello/blob/main/LICENSE)\n\nHyperledger Cello is a blockchain provision and operation system, which helps manage blockchain networks in an efficient way.\n\n1. [Introduction](#introduction)\n2. [Quick Start](#quick-start)\n3. [Main Features](#main-features)\n4. [Documentation](#documentation-getting-started-and-develop-guideline)\n5. [Why named cello?](#why-named-cello)\n6. [Notice](#incubation-notice)\n7. [Inclusive Language Statement](#inclusive-language-statement)\n   \n## Introduction\n\nUsing Cello, everyone can easily:\n\n* Build up a Blockchain as a Service (BaaS) platform quickly from scratch.\n* Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network v1.0.\n* Maintain a pool of running blockchain networks on top of baremetals, Virtual Clouds (e.g., virtual machines, vsphere Clouds), Container clusters (e.g., Docker, Swarm, Kubernetes).\n* Check the system status, adjust the chain numbers, scale resources... through dashboards.\n\nA typical usage scenario is illustrated as:\n\n![Typical Scenario](docs/images/scenario.png)\n\n## Quick Start\n\nEnvironmental preparation:\n\n1. docker [how install](https://get.docker.com)\n2. docker compose(`we switched to` [Docker Compose V2](https://docs.docker.com/compose/#compose-v2-and-the-new-docker-compose-command)) [how install](https://docs.docker.com/compose/install/)\n3. make `all script for cello service management is written in Makefile`\n4. kubernetes (`optional`) [how install](https://kubernetes.io/docs/setup/)\n5. node [how install](https://nodejs.org/en/download/)\n\nIf environment is prepared, then we can start cello service.\n\n* Set local storage environment variable, e.g. Use current path as storage path\n\n  ```bash\n  $  export CELLO_STORAGE_PATH=$(pwd)/cello\n  ```\n\n\n* Start service locally\n\n  ```bash\n  $ make local\n  ```\n\n* Optional: Build essential images for cello service (the docker hub image auto build haven't ready, in the future you can ignore this step.)\n\n  * Build docker images\n    ```bash\n    $ make docker\n    ```\n  * Then run services locally then\n\n    ```bash\n    $ make start\n    ```\n\n* After service started up, if use docker-compose method, you can see output:\n\n  ```bash\n  CONTAINER ID   IMAGE                            COMMAND                  CREATED         STATUS         PORTS                                                                                  NAMES\n  81e6459965ec   hyperledger/cello-agent-docker   \"gunicorn server:app…\"   4 seconds ago   Up 2 seconds   0.0.0.0:2375-\u003e2375/tcp, :::2375-\u003e2375/tcp, 0.0.0.0:5001-\u003e5001/tcp, :::5001-\u003e5001/tcp   cello.docker.agent\n  04367ab6bd5e   postgres:11.1                    \"docker-entrypoint.s…\"   4 seconds ago   Up 2 seconds   0.0.0.0:5432-\u003e5432/tcp, :::5432-\u003e5432/tcp                                              cello-postgres\n  29b56a279893   hyperledger/cello-api-engine     \"/bin/sh -c 'bash /e…\"   4 seconds ago   Up 2 seconds   0.0.0.0:8080-\u003e8080/tcp, :::8080-\u003e8080/tcp                                              cello-api-engine\n  a272a06d8280   hyperledger/cello-dashboard      \"bash -c 'nginx -g '…\"   4 seconds ago   Up 2 seconds   80/tcp, 0.0.0.0:8081-\u003e8081/tcp, :::8081-\u003e8081/tcp                                      cello-dashboard\n  ```\n\n* Stop cello service.\u003c!---, same as start, need set the `DEPLOY_METHOD` variable.--\u003e\n\n  ```bash\n  $ make stop\n  ```\n\n* Clean all containers\n\n  ```bash\n  $ make clean\n  ```\n\n* Check available make rules\n\n  ```bash\n  $ make help\n  ```\n\n* Visit Cello dashboard at `localhost:8081`\n\n* Check [troubleshoot](https://github.com/hyperledger/cello/blob/main/docs/setup/server.md#3-troubleshoot) section if you get any question.\n\n## Main Features\n\n* Manage the lifecycle of blockchains, e.g., create/start/stop/delete/keep health automatically.\n\n* Support customized (e.g., size, consensus) blockchains request, currently we mainly support [Hyperledger fabric](https://github.com/hyperledger/fabric).\n\n* Support native Docker host, swarm or Kubernetes as the worker nodes. More supports on the way.\n\n* Support heterogeneous architecture, e.g., X86, POWER and Z, from bare-metal servers to virtual machines.\n\n* Extend with monitor, log, health and analytics features by employing additional components.\n\n## Documentation, Getting Started and Develop Guideline\n\nFor new users, it is highly recommended to read the [documentation](docs/index.md) first.\n\nAnd feel free to visit the [online documentation](http://cello.readthedocs.io/en/latest/) for more information. You can also run `make doc` to start a local documentation website (Listen at [localhost:8000](http://127.0.0.1:8000).\n\n## Why named Cello?\n\nCan you find anyone better at playing chains? :)\n\n## Incubation Notice\n\nThis project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc).\n\n## Inclusive Language Statement\n\nThese guiding principles are very important to the maintainers and therefore\nwe respectfully ask all contributors to abide by them as well:\n\n* Consider that users who will read the docs are from different backgrounds and\n  cultures and that they have different preferences.\n* Avoid potential offensive terms and, for instance, prefer \"allow list and\n  deny list\" to \"white list and black list\".\n* We believe that we all have a role to play to improve our world, and even if\n  writing inclusive documentation might not look like a huge improvement, it's a\n  first step in the right direction.\n* We suggest to refer to\n  [Microsoft bias free writing guidelines](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)\n  and\n  [Google inclusive doc writing guide](https://developers.google.com/style/inclusive-documentation)\n  as starting points.\n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"\u003e\u003cimg alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eThis work is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"\u003eCreative Commons Attribution 4.0 International License\u003c/a\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger-cello%2Fcello","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger-cello%2Fcello","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger-cello%2Fcello/lists"}