Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
0670af0
Create introduction and prerequisites lessons
dodo920306 Aug 4, 2025
63b4852
Add dark mode
dodo920306 Aug 4, 2025
8361d3a
Add navigation tabs
dodo920306 Aug 4, 2025
d1c268d
Add logo into README and homepage
dodo920306 Aug 4, 2025
376f6c1
Create the server-only compose file
dodo920306 Aug 4, 2025
2277761
Add the 'back-to-top' button
dodo920306 Aug 4, 2025
9346895
Allow local build docs can be access from the outside by default
dodo920306 Aug 4, 2025
42546ed
Make 'docs' same as 'doc' to `make` commands
dodo920306 Aug 4, 2025
eb6fc50
Add `make server`
dodo920306 Aug 4, 2025
7cb46c1
Update mermaid style
dodo920306 Aug 4, 2025
af820b4
Merge branch 'main' into task/provide-first-4-lessons-of-the-tutorial
dodo920306 Aug 11, 2025
dcbc1b6
Add the 'copy-code' buttons
dodo920306 Aug 4, 2025
c73561f
Change the Ubuntu font to the "Sans" versions
dodo920306 Aug 11, 2025
33c94ee
Create tutorial lesson 3: server
dodo920306 Aug 11, 2025
9619c67
Add `make agent` command to start a agent independently
dodo920306 Aug 12, 2025
744c944
Create lesson 3: agent
dodo920306 Aug 12, 2025
d3418f4
Create lesson 4: User & Organization
dodo920306 Aug 13, 2025
3659d84
Add navigation footer
dodo920306 Aug 13, 2025
244e13a
Add admonitions
dodo920306 Aug 13, 2025
e6cdc5d
Tell users they can write their own compose files
dodo920306 Aug 13, 2025
64e4d6e
Create lesson 5: agent, network, and node
dodo920306 Aug 13, 2025
c196b28
Create "Lesson 6: Channel and Chaincode"
dodo920306 Aug 14, 2025
55cf7ce
Tell beginners to read tutorials first
dodo920306 Aug 14, 2025
dd70e30
Remove obsolete or unfinished pages from the index
dodo920306 Aug 14, 2025
09d529b
Remove operations from the homepage
dodo920306 Aug 14, 2025
a176aaf
Merge branch 'main' into task/provide-first-4-lessons-of-the-tutorial
yeasy Aug 16, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ deep-clean: ##@Clean Stop services, clean docker images and remove mounted local
make clean-images
rm -rf $(LOCAL_STORAGE_PATH)

docs:
make doc

doc: ##@Documentation Build local online documentation and start serve
command -v mkdocs >/dev/null 2>&1 || pip install -r docs/requirements.txt || pip3 -r docs/requirements.txt
mkdocs serve -f mkdocs.yml
Expand Down Expand Up @@ -216,7 +219,7 @@ images: api-engine docker-rest-agent fabric dashboard

api-engine:
docker build -t hyperledger/cello-api-engine:latest -f build_image/docker/common/api-engine/Dockerfile.in ./ --platform linux/$(ARCH)

docker-rest-agent:
docker build -t hyperledger/cello-agent-docker:latest -f build_image/docker/agent/docker-rest-agent/Dockerfile.in ./ --build-arg pip=$(PIP) --platform linux/$(ARCH)

Expand All @@ -226,15 +229,19 @@ fabric:
dashboard:
docker build -t hyperledger/cello-dashboard:latest -f build_image/docker/common/dashboard/Dockerfile.in ./

server:
docker compose -f bootup/docker-compose-files/docker-compose.server.dev.yml up -d --force-recreate --remove-orphans


agent:
docker compose -f bootup/docker-compose-files/docker-compose.agent.dev.yml up -d --force-recreate --remove-orphans

.PHONY: \
all \
license \
check \
check-api \
check-dashboard \
docs \
doc \
help \
docker \
Expand All @@ -253,4 +260,6 @@ dashboard:
clean-images \
start-docker-compose \
stop-docker-compose \
images \
images \
server \
agent
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Cello](docs/images/favicon.png)
![Cello](docs/images/logo.svg)

[![Release](https://img.shields.io/github/v/release/hyperledger-cello/cello)](https://github.com/hyperledger-cello/cello/releases)
[![Build Status](https://github.com/hyperledger/cello/actions/workflows/docker-image.yml/badge.svg)](https://github.com/hyperledger/cello/actions/workflows/docker-image.yml)
Expand Down
27 changes: 27 additions & 0 deletions bootup/docker-compose-files/docker-compose.agent.dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#
# SPDX-License-Identifier: Apache-2.0
#

services:
cello-docker-agent:
image: hyperledger/cello-agent-docker
container_name: cello-docker-agent
hostname: cello.docker.agent
restart: always
ports:
- "2375:2375"
- "5001:5001"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
environment:
- DOCKER_URL=unix://var/run/docker.sock
- STORAGE_PATH=${CELLO_STORAGE_PATH:-/opt/cello}/hyperledger
networks:
- cello-net

networks:
cello-net:
name: cello-net

volumes:
cello-docker-agent:
67 changes: 67 additions & 0 deletions bootup/docker-compose-files/docker-compose.server.dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
#
# SPDX-License-Identifier: Apache-2.0
#

services:
cello-dashboard:
image: hyperledger/cello-dashboard
container_name: cello-dashboard
ports:
- "${DASHBOARD_SERVICE_PORT}:8081"
networks:
- cello-net
depends_on:
- cello-api-engine

# pg database
cello-postgres:
image: postgres:12.0
container_name: cello-postgres
restart: unless-stopped
environment:
- POSTGRES_DB=api_engine
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=123456
ports:
- "5432:5432"
volumes:
- ${CELLO_STORAGE_PATH:-/opt/cello}/pgdata:/var/lib/postgresql/data
networks:
- cello-net

# api engine service of cello
cello-api-engine:
image: hyperledger/cello-api-engine
container_name: cello-api-engine
restart: unless-stopped
stdin_open: true
dns_search: .
environment:
- GODEBUG=netdns=go
- DB_NAME=api_engine
- DB_USER=postgres
- DB_PASSWORD=123456
- DB_HOST=cello-postgres
- CELERY_BROKER_URL=redis://redis
- DB_PORT=5432
- DEBUG=True
- CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
- FABRIC_LOGGING_SPEC=INFO
- [email protected]
ports:
- "8080:8080"
volumes:
- ${CELLO_STORAGE_PATH:-/opt/cello}:/opt/cello
networks:
- cello-net
depends_on:
- cello-postgres

networks:
cello-net:
name: cello-net

volumes:
cello-api-engine:
cello-postgres:
cello-dashboard:
5 changes: 5 additions & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

hero: All concepts related to cello

# Concepts
Expand Down
5 changes: 5 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

[//]: # (SPDX-License-Identifier: CC-BY-4.0)

## Introduction
Expand Down
5 changes: 5 additions & 0 deletions docs/design/arch.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

# Architecture Design

Here we discuss the architecture design for the mangement services on the Master node.
Expand Down
2 changes: 0 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
## Questions

* [What is cello?](#what-is-cello)

### What is cello?

Hyperledger Cello is a blockchain provision and operation system, which helps manage blockchain networks in an efficient way.
Loading
Loading