Skip to content

Latest commit

 

History

History
138 lines (103 loc) · 5.7 KB

ManualInstallation.md

File metadata and controls

138 lines (103 loc) · 5.7 KB
Raw

how to install Brenthy and each of its components manually This is useful for installing Brenthy on operating systems for which no fully automated Brenthy installer has been built yet. To install Brenthy using an automated installer, see InstallingBrenthy For detailed documentation on how the automated installation works, see ../Technical/Installation.md This guide is written generically to apply to all operating systems. It therefore does not provide detailed step-by-step instructions, instead it provides generic instructions which the reader must apply to their operating system. Examples for more detailed steps are sometimes provided for Debian-based Linux OSs.

Installing Brenthy Manually

User's Prerequisite Knowledge & Skill

Prerequisites

  • Python3 and Python's package manager pip - On most Linux operating systems, python comes preinstalled. You can check this by reading the output of running the following commands:
# Check for python 3, depending on OS
python --version
python3 --version

# Check for pip, depending on OS
pip --version
pip3 --version
sudo apt install python3-virtualenv
  • IPFS - Make sure you have installed and initialised IPFS - Enable IPFS' experimental LibP2P-Stream-Mounting feature, then run IPFS with the following commands:
ipfs config --json Experimental.Libp2pStreamMounting true

# run IPFS
ipfs daemon --enable-pubsub-experiment

Brenthy Installation

Once you've installed the systems listed in Prerequisites, you are ready to install Brenthy itself. Follow these steps to do so:

  1. Choose an installation directory. This is the folder where Brenthy's source code, update backups and log files will be stored. We will refer to it as INSTALL_DIR in the rest of this guide.
  2. Choose and create a storage directory. This is the folder where blockchains will store their blocks and other data. We will refer to it as DATA_DIR in the rest of this guide. The default DATA_DIR is a subfolder of the INSTALL_DIR called BlockchainData. If you are using a different path, create a symlink from the default data directory to your custom DATA_DIR:
ln -s $DATA_DIR $INSTALL_DIR/BlockchainData
  1. Move the Brenthy source code folder (the Brenthy subfolder of this project's root) to INSTALL_DIR. The directory tree should look something like this:
INSTALL_DIR
└── Brenthy
	├── api_terminal
	├── app_data.py
	├── blockchain_manager.py
	├── blockchains
	├── brenthy_tools_beta
	├── install.py
	├── InstallScripts
	├── __main__.py
	├── pip_install.py
	├── __project__.py
	├── ReadMe.md
	├── recent_blocks_record.py
	├── requirements.txt
	├── run.py
	├── setup.py
	├── uninstall.py
	└── update.py

  1. In INSTALL_DIR, create a folder called Python and install a Python interpreter and the python libraries listed in Brenthy/requirements.txt there. You have two options for installing an interpreter: CPython (using the virtualenv command) and PyPy (simple download). PyPy is recommended as it has better performance.

    • Option 1: CPython (using virtualenv)
## Linux

cd $INSTALL_DIR

# create virtual environment in a folder called Python
virtualenv Python

# in the virtual environment, install the necessary libraries
source Python/bin/activate
pip install -r Brenthy/requirements.txt
- Option 2: PyPy

## Linux

mkdir $install_dir/Python

# download pypy to a temporary directory
TEMP_DIR=$(mktemp -d)
wget -P $TEMP_DIR $PYPY_URL
ARCHIVE_FILENAME=$(basename $PYPY_URL)
tar -xjf $TEMP_DIR/$ARCHIVE_FILENAME -C $TEMP_DIR
EXTRACTED_DIR_NAME="${ARCHIVE_FILENAME%.tar.bz2}"

mv ${TEMP_DIR}/${EXTRACTED_DIR_NAME}/* $install_dir/Python/

# install pip, the package manager
/opt/Brenthy/Python/bin/python -m ensurepip
Python/bin/python -m pip install --upgrade pip

# install a specific version of ecies, as the default's doesn't currently work
Python/bin/python -m pip install eciespy@git+https://github.com/ecies/py
Python/bin/python -m pip -qq install -r $install_dir/Brenthy/requirements.txt
  1. On you operating system, create a system user called brenthy with no login permissions and a home directory at INSTALL_DIR. This user will own your INSTALL_DIR and DATA_DIR folders and will run Brenthy.
# Linux
useradd --system --home $INSTALL_DIR -M -r -s /usr/sbin/nologin brenthy
  1. Change the ownership of the INSTALL_DIR and DATA_DIR folders and their content to the brenthy user.
# Linux
chown -R brenthy $INSTALL_DIR
chown -R brenthy $DATA_DIR
  1. Change the permissions of the INSTALL_DIR and DATA_DIR folders and their content to read-only for everybody other than the brenthy user.
  2. Configure your operating system to run the installation directory using the virtual python environment as the brenthy user automatically on startup. On Linux, the command to run the source code using the virtual environment is:
$INSTALL_DIR/Python/bin/python $INSTALL_DIR/Brenthy