Server

1. System Requirement¶

Hardware: 4c8g100g
Linux Kernel >= 3.0.0
Docker engine: 20.10.17+
docker compose: 2.6.1+

2. Setup Steps¶

2.1 Clone source code¶

$ git clone https://github.com/hyperledger/cello.git

2.2 Prepare environment¶

docker how install
docker compose (we switched to Docker Compose V2) how install
make all script for cello service management is written in Makefile
kubernetes (optional) how install
node how install

As Docker Compose V1 will reach its end of life in April 2023, we switched Docker Compose to V2. Please ensure that you install the correct version.

2.3 Build local images(optional)¶

Because currently the dockerhub image auto build haven't ready, in the future you can ignore this step.
Build API Engine
```
$ make api-engine
```
Build Docker Agent
```
$ make docker-rest-agent
```
Build Docker Dashboard
```
$ make dashboard
```

2.4 Start service¶

Start cello service.

$ make start

3. Troubleshoot¶

3.1 Error after running `make start`¶

Mounts denied error when using Docker Desktop

Error message:

Error response from daemon: Mounts denied:
The path /opt/cello is not shared from the host and is not known to Docker.
You can configure shared paths from Docker -> Preferences... -> Resources -> File Sharing.
See https://docs.docker.com/ for more info.
make[1]: *** [Makefile:215: start-docker-compose] Error 1

Solution:

$ sudo mkdir /opt/cello

# Then go to Docker Desktop -> Preferences... -> Resources -> File Sharing
# Add the path /opt/cello into the File Sharing list, apply the change and restrt Docker Desktop

3.2 Unable to register¶

Docker has no access to the folder /opt/cello

Error message in HTTP response:

msg   [ "CryptoConfig create failed for [Errno 2] No such file or directory: '/opt/cello/${your organization name}/crypto-config.yaml'!" ]

First try
```
$ sudo make start
```
If there is any error or you still cannot register, change the permission of the folder
```
$ sudo chown -R !(whoami): /opt/cello
```

This work is licensed under a Creative Commons Attribution 4.0 International License.