hivecomputing/hive-disk repository overview

⁠hiveDisk for servers (contribution mode only) with Docker

⁠Summary

hiveDisk for servers allows you to contribute storage space and as a consequence earn storage space which can be used with your hiveDisk account on other devices.

The hive agent (underlying daemon software) can be run in contribution mode in order to support scenarios where you would like to contribute storage space to the hive network on a server, NAS, or system where the hive desktop application cannot be deployed. This in turns allows using the earned contribution space on the hive network on other devices.

⁠Prerequisites

You need:

• A user account (you can create one with the desktop application)
• To have completed the onboarding process during your registration (also with the desktop application)

⁠Installation

Pull the latest docker image from Docker Hub

docker pull hivecomputing/hive-disk:latest

⁠Usage

⁠Set up a default configuration

• Create a directory (in your location of choice) that will contain persistent data and configuration.This directory will be mapped to a volume inside the container. Nothing is lost when the container is stopped or restarted.

mkdir hivedata
sudo chown :4200 hivedata # Set the owner group to 4200
sudo chmod 775 hivedata
sudo chmod g+s hivedata # Makes subsequent file/dir creation inherit group id from the parent folder

docker run -p 8080:8080 -p 4443:4443 -p 4001:4001 -v /etc/machine-id:/etc/machine-id -v /var/lib/dbus/machine-id:/var/lib/dbus/machine-id -v ${PWD}/hivedata:/home/hive/.hive hive-agent:latest hive-agent config init

This will generate a config.yaml file in your docker ~/.hive directory, with the following message Generated and saved a new configuration!.

Note that the user running the hive-agent daemon process must have sufficient permissions to create file and directories for the specified absolute path.

⁠Start the hive-agent daemon

Starting the hive-agent daemon is done by invoking the hive-agent binary along with the contribute command and the amount of space in GB you intend to contribute.

docker run -p 8080:8080 -p 4443:4443 -p 4001:4001 -v /etc/machine-id:/etc/machine-id -v /var/lib/dbus/machine-id:/var/lib/dbus/machine-id -v ${PWD}/hivedata:/home/hive/.hive hivecomputing/hive-disk:latest hive-agent contribute XX

where XX represents the contribution space storage (in GB). Its value must be a number greater or equal than 5.

At first, the hive-agent daemon will require to self-authenticate. The URL to complete the authentication challenge will be provided in the stdout stream and you will need to open the challenge URL in a web browser. If you cannot see any URL, check with docker logs.

Challenge received, user code to validate is : ZFMZ-GMXW
A browser should automatically open so you can complete the onboarding flow.
In case it does not open, please complete the flow manually by visiting the following URL in a browser 
https://hivenet-prod.eu.auth0.com/activate?user_code=ZFMZ-GMXW

Please complete the authentication challenge in browser whithin the next 900 second

Once the challenge is completed, a refresh token will be stored encrypted in your ~/.hive directory. From this point on, the challenge should not be required anymore.

If the process does not return an error code and you see the following in the logs: Agent started in : XXXXms You are now part of the hive network and effectively contributing space!

⁠Contact us

If you have any feedback or encounter an issue when running hiveDisk, please contact [email protected]⁠