Get Started
This section covers repository configuration, and installation.
Last updated
This section covers repository configuration, and installation.
Last updated
To properly build components, you must have a system with the following requirements:
Linux (Ubuntu Preferred) Version: 20.04 or Above Mac(Apple Silicon or Intel) Version: Big Sur or Above Windows : Windows 10 or Above
4 vCPU, 4 GB Memory at minimum
4 GB of space minimum for zbox build components and storage allocation.
Download the latest linux zboxcli archive release from .
Open terminal and extract the downloaded archive to a specified directory using the command below.
Provide execution privileges to the zbox executable.
4. Navigate to the extracted directory path
Run the zbox executable type by using the command below.
On successful installation you will see a help section similar to response below:
Extract the executable from the archive zbox-windows.zip
Now run the executable zbox.exe in windows command prompt.
On successful installation, you will see a help section similar to response below :
Open terminal and extract the downloaded archive to a specified directory using the commands below:
3. Provide execution privleges to the zbox executable.
Navigate to extracted directory path .
Run the zbox executable using the command below.
On successful installation you will see a help section :
Windows 64bit (tested with Windows 11)
Open MSYS2 MINGW64 shell from the windows start menu. The MINGW64 shell window should look similar to screenshot below.
Install the following libraries:
Install clang, go for mingw64 and unzip
Note: Restart mingw64 shell for Go to make changes.
Set environment variables
Clone zboxcli
Navigate to zboxcli directory and run the following command :
Unzip and copy dll's to zboxcli directory. The zboxcli directory will be available at the following path C:\msys64\home\<your_windows_username>\zboxcli if cloned under mingw64 shell.
Now run the ./zbox command under zboxcli directory
On a successful build you will see a help section.
The build essential package is required to build and make the zbox application. It includes the necessary GCC/g++ compilers and other essential critical libraries and utilities.
Run apt update command to update the packages
Get build-essential package
Clone the zboxcli repository using the command
Navigate into zboxcli directory using
Use the make install command to compile the source code .
This might take a minute. Here is a sample response of successful make install command:
Start the Zbox by navigating back to the zboxcli directory usingcd zboxcli and type
On a successful build you will see a help section.
Make a new .zcn folder in the home directory of your system
Open the config.yaml file located at $HOME/.zcn path of your system.The contents should be similar to the file below.
Zbox connects to the Züs network using the block_worker field. These network details are automatically fetched from the blockWorker's network API. Preferred Blobbers are also present which you can uncomment for using specified storage providers for handling your files.
The section assumes you have successfully build zbox. zbox provides a long list of components to use. Let's begin with the allocation of storage space on the 0Chain decentralized network.
For creating a storage allocation using Zbox. You need to have a wallet with tokens available for performing allocations.
Once the wallet is created and has an available balance, you can create a storage allocation by using the Zbox newallocationcommand. To understand the syntax type
This will output the mandatory and optional flags that need to be added with the newallocationcommand. Here are the parameters :
allocationFileName
local file to store allocation information
allocation.txt
file path
cost
returns the cost of the allocation, no allocation created
flag
data
number of data shards, effects upload and download speeds
2
int
expire
duration to allocation expiration
720h
duration
free_storage
free storage marker file.
file path
owner
owner's id, use for funding an allocation for another
string
owner_public_key
public key, use for funding an allocation for another
string
lock
lock write pool with given number of tokens
float
mcct
max challenge completion time
1h
duration
parity
number of parity shards, effects availability
2
int
read_price
filter blobbers by read price range
0-inf
range
size
size of space reserved on blobbers
2147483648
bytes
usd
give token value in USD
flag
write_price
filter blobbers by write price range
0-inf
range
For getting started we can create a basic allocation with default types. This will only require essential specifiers such as lock float. We will add a float value of 0.5 which will lock 0.5 tokens with the allocation. The complete command for creating an allocation would be:
Successful Response will create an allocation with allocation ID:
7. Verify the allocation by using the command.
Unzip and copy dll's to zboxcli directory. The zboxcli directory will be available at the following path C:\msys64\home\<your_windows_username>\zboxcli if cloned under mingw64 shell.
Now run the ./zbox command under zboxcli directory
6.
7. .
Download the latest windows zboxcli archive release from .
5.
6.
Download the latest mac zboxcli archive release from .
6.
7.
Installing msys2 from .
Download necessary dll files as zip from .
11.
12.
Installation instructions for Mac and Linux can be found.
7.
8.
Configuration for the Züs network by default is stored in network/config.yaml file of the zbox github which we will copy to a new config.yaml file in our local system .
Note: For windows create a folder named .zcn at `C:\Users\<windows_username>`path.
2. Copyfrom zboxcli repo to .zcn directory
Note: In case you are configuring zbox network for the block_worker in config file above should be set to
Create and get test tokens into your wallet using the zwallet CLI tool. If you have not installed zwallet CLI check instructions for and .
If you are not able to create allocation and getting errors, check error causes .
Download necessary dll files as zip from .
