Skip to content

Latest commit

 

History

History
77 lines (63 loc) · 3 KB

InstallingBrenthy.md

File metadata and controls

77 lines (63 loc) · 3 KB
Raw

how to install Brenthy For details on how Brenthy's installation process works at the technical level, see ../Technical/Installation.md. To uninstall Brenthy, see ./Uninstall.md

Installing Brenthy

List of Platforms Supported by Auto-Installation

  • Linux with systemd

For other platforms, complete and reliable installation scripts have not yet been fully developed.
To install Brenthy on other platforms, follow the manual installation guide.
To develop automated installation scripts for other platforms, study manual installation guide and the technical installation documentation

Installing

Prerequisites

  • Make sure you have Python 3 and Python's package manager pip installed.
    • 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
  • Install Python's virtualenv package
    • On Debian-based operating systems run:
     sudo apt install python3-virtualenv

Install Brenthy

Download Brenthy's source code, go into its directory and run it with Python. Make sure you are running it from a user with superuser privileges or root.

# make temporary directory
mkdir /tmp/brenthy_installation
cd /tmp/brenthy_installation
# download Brenthy source code
ipfs get /ipns/k2k4r8nismm5mmgrox2fci816xvj4l4cudnuc55gkfoealjuiaexbsup/Sites/BrenthyAndWalytis/Brenthy.zip
unzip Brenthy.zip

# Run Brenthy, it will offer to install itself.
python3 .

When running on a supported platform, Brenthy will offer to install itself. After typing 'y', you will need to enter your password (if you are not already root), and then Brenthy will install itself.

Brenthy will install itself without asking if the --install or --install-dont-run flags are passed, for example:

python3 . --install

If you want Brenthy to use a different location for storing its blockchains' data than the default, create your custom directory first, then pass it with the --data-dir parameter when running Brenthy with python, for example:

python3 . --install --data-dir /path/to/blockchains_storage

Installation Notes:

Debian, Ubuntu and Other Systemd-Enabled Linux

On linux systems with systemd, the Brenthy installation creates systemd services for both Brenthy and Kubo (IPFS).

You can always use the following commands to stop, start and restart those services running in the background:

# Brenthy
sudo systemctl stop brenthy
sudo systemctl start brenthy
sudo systemctl restart brenthy

# Kubo (IPFS)
sudo systemctl stop ipfs
sudo systemctl start ipfs
sudo systemctl restart ipfs

If you restart IPFS, you will need too restart Brenthy afterwards for it to work properly.