Apla is an open source blockchain platform which implemented as blockchain network consisting of nodes communicating each other. Each node is backend service having own database and can be interacted by the end user with a client or web UI.
The goal of this quick start solution is to run a local testing network of several Apla nodes (backends with GUI clients) to give the end user an idea of how Apla blockchain works and provide usage examples of graphical interface elements as well as smart-contracts.
The backend-side (backend itsef and database engine) software runs in docker containers and clients run natively on the host system side. As soon as clients start user can interact with local testing Apla blockchain network.
Currently Apla quick start was tested on Mac and Linux. Windows support is coming.
Use manage.sh to manage Apla testbed on Linux/Mac and manage.exe to manage Apla testbed on Windows.
To create a testing network of 5 nodes on Linux/Mac use the following command:
on Mac with Admin account:
./manage.sh install 5on Linux with sudo-enabled account:
sudo ./manage.sh install 5This will download and install all required software (docker if it's not installed yet, docker containers with Apla backends and databases and Apla clients) and start 5 Apla backend instances and 5 accordingly connected Apla clients.
To stop clients and to stop and delete docker containers run this command:
on Mac with Admin account:
./manage deleteon Linux with sudo-enabled account:
sudo ./manage deleteTo stop clients and to stop and delete docker containers and images run this command:
on Mac with Admin account:
./manage delete-allon Linux with sudo-enabled account:
sudo ./manage delete-allTo check the status of the testing network run this command:
on Mac with Admin account:
./manage statuson Linux with sudo-enabled account:
./manage statusTo start database shell connected to appropriate backend's database run:
on Mac with Admin account:
./manage db-shell Non Linux with sudo-enabled account:
sudo ./manage db-shell Nwhere N is the number of a backend.
To stop all clients run:
on Mac with Admin account:
./manage stop-clientson Linux with sudo-enabled account:
sudo ./manage stop-clientsTo start clients again run:
on Mac with Admin account:
./manage start-clientson Linux with sudo-enabled account:
sudo ./manage start-clientsTo reinstall (delete all Apla-related containers and run installation again with the last installation parameters) run:
on Mac with Admin account:
./manage reinstallon Linux with sudo-enabled account:
sudo ./manage reinstallA password is required to confirm transactions. The default password is 'default'.
By default docker backends and database listening ports are exposed to the system by the following rules:
- Database port is exposed to the system port 15432
- Web frontend ports are exposed to 'web port shift' value (8300 by default) plus the index number of a backend, for example, the listening port of the first backend by default is exposed to 8301, the second - to 8302 and so on
- Client ports are exposed to 'client port shift' value (17300 by default) plus the index number of a backend, for example, the listening port of the first backend by default is exposed to 17301, the second - to 17302 and so on
These default ports shifts values can be changed during installation:
on Mac with Admin account:
./manage.sh install N WPS CPS DBP BLEXPon Linux with sudo-enabled account:
./manage.sh install N WPS CPS DBP BLEXPwhere:
- N - the number of backends (maximum 5);
- WPS - web port shift - optional parameter, default value: 8300;
- CPS - client port shift - optional parameter, default value: 17300;
- DBP - database port - optional parameter, default value: 15432.
- BLEXP - block explorer port - optional parameter, default value: 18200.
So running this command:
on Mac with Admin account:
./manage.sh install 4 9000 19000 6000on Linux with sudo-enabled account:
./manage.sh install 4 9000 19000 6000will start 4 backends and 4 clients, and frontend ports will be exposed to system port: 9001, 9002, 9003, 9004, clients ports will be exposed to system ports: 19001, 19002, 19003, 19004, and database port will be exposed to system port 6000
Initial support of Block Explorer was implemented. The default host port for it is 18200, use browser to open it.