INSTALL - thomas-z8/chia-blockchain GitHub Wiki
To install the chia-blockchain, follow the instructions according to your operating system. After installing, follow the remaining instructions in the Quick Start Guide to run the software. You should read the release notes and README.md as well. This wiki has a FAQ that is also helpful.
| Jump to: | MacOS | Ubuntu | WSL2 | Amazon Linux 2 | CentOS/RHEL | Other platforms |
|---|
All keys and plots from version prior to Beta 1.8 are deprecated and can be deleted. Plots from both Beta 1.8 and newer should work on mainnet.
Updating from 1.8 - 1.14:
Keys and configs from 1.8 and newer should automatically migrate. For more details, read the FAQ. Beta 12/13's blockchain is new and does not bring forward previous test chia.
Windows
Install the Windows installer - Chia Blockchain Windows
As the Chia code signing certificate is new you will likely have to ask to keep the download and when you run the installer, you will have to choose "More Info" and "Run Anyway" to be able to run the installer. There is no need to use the command line.
If you have previously installed Chia, you should use Windows Add/Remove to uninstall earlier versions of Chia though the installer will automatically uninstall the previous version.
You can now proceed to the Quick Start Guide
MacOS
MacOS Mojave (10.14.x) or newer is required.
Install the MacOS dmg installer - Chia Blockchain MacOS
When the installer first runs it will import or create multiple keys and add them to the MacOS keychain. You may be prompted up to 3 times for your password. We suggest choosing "always allow."
You can now proceed to the Quick Start Guide
To build a development version, make sure brew is available before starting the setup and that python 3.7 or newer is installed.
git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain
sh install.sh
. ./activate
cd electron-react
npm run build
npm run electron
Ubuntu/Debian
Install dependencies for Ubuntu 20.04 LTS. If you are installing on Ubuntu 18.04 LTS you should use Python 3.7 instead: sudo apt-get install python3.7-venv python3.7-distutils git -y
sudo apt-get update
sudo apt-get upgrade -y
# Checkout the source and install
git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain
sh install.sh
. ./activate
sh install-gui.sh
cd electron-react
npm run electron &
#Update from previous version
cd chia-blockchain
chia stop all -d
deactivate
git pull
sh install.sh
. ./activate
sh install-gui.sh
cd electron-react
npm run electron &
WSL2
You can run chia-blockchain in Ubuntu 20.04 LTS via WSL2 on Windows.
NOTE: WSL2 plotting is currently only slightly faster than plotting on the native windows client. WSL2 requires significant tweaking to set up correctly. If you find that daunting, it's probably easier to just use the native windows client.
You can not run the GUI as WSL2 doesn't yet support graphical interfaces from WSL2.
Check if you already have WSL2 or WSL1 installed:
From PowerShell, type:
wsl -l -v
If you get a listing of help topics for wsl commands, you have WSL1, and need to upgrade. To upgrade, follow the instructions here. If you get a blank result or a listing of installed Linux versions, you have WSL2 and are OK to proceed.
If WSL is not installed:
From an Administrator PowerShell:
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all
You will be prompted to reboot.
Installing a new WSL2 instance:
Install Ubuntu 20.04 LTS from the Microsoft Store and run it and complete its initial install steps. You now have a linux bash shell environment that can run linux native software on Windows.
Then follow the steps below which are the same as the usual Ubuntu instructions above with a target of Python 3.8.
sudo apt-get update
sudo apt-get upgrade -y
git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain
sh install.sh
. ./activate
Running a standalone Windows wallet gui is deprecated but may return in later versions. You can run the Windows version and share keys. You can also plot in WSL2 and migrate the plots to a Windows farmed plot directory.
Increasing the WSL Maximum Storage Capacity
WSL2 uses a Virtual Hardware Disk (VHD) to store files, and it automatically resizes as files grow. However, the VHD has an initial maximum size of 256 GB. Therefore, the default WSL2 VHD is probably only capable of plotting k=30 plots. To plot anything larger, you will need to increase the maximum allowable size. Follow the guide here.
Setting a maximum limit to WSL2 memory access
If you try plotting Chia in WSL2 without limiting the memory access, WSL2 will use 100% of your available machine's memory, and your computer will get bogged down and begin swapping memory to your hard drive. This will severely cripple your plotting speeds. To set the maximum memory that WSL2 is allowed to use, create a configuration file as described in this guide.
WSL VHD Plotting Nuance
Plotting within WSL2 can write to either the native VHD (which is EXT4) or to any other drive, which can be NTFS or any other FS-type. Writing to the native VHD is faster than writing out to another drive.
Plotting uses three commands for directory control:
-t for initial temp directory. Phases 1 and 2 happen here.
-2 for secondary temp directory. Phase 3 (compression) happens here.
-d for final destination. Phase 4 happens here.
Plotting works such that -t and -2 require the exact same amount of storage space. Therefore, if -t and -2 point to the same drive, that drive needs 2x the final file size + 1x the max working file size.
For maximum speed, -t and -2 should be inside the WSL2 filesystem. Something like: -t ~/chia_temp -2 ~/chia_temp. Just beware that the WSL2 VHD will need a much larger maximum capacity.
-d can point to any other drive for the final destination.
Amazon Linux 2
sudo yum update -y
sudo yum install python3 git -y
git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain
sh install.sh
. ./activate
# gui
cd electron-react
npm run build
npm run electron
# Or install chia-blockchain as a binary package
curl -sL https://rpm.nodesource.com/setup_10.x | sudo bash -
sudo yum install -y nodejs
python3.7 -m venv venv
ln -s venv/bin/activate
. ./activate
pip install --upgrade pip
pip install -i https://download.chia.net/simple/ miniupnpc==2.1 setproctitle==1.1.10 cbor2==5.1.2
pip install chia-blockchain==1.0b15
CentOS/RHEL 7.7 or newer
sudo yum update -y
# Compiling python 3.7 is generally required on CentOS 7.7 and newer
sudo yum install gcc openssl-devel bzip2-devel libffi libffi-devel -y
sudo yum install libsqlite3x-devel -y
wget https://www.python.org/ftp/python/3.7.7/Python-3.7.7.tgz
tar -zxvf Python-3.7.7.tgz ; cd Python-3.7.7
./configure --enable-optimizations; sudo make -j$(nproc) altinstall; cd ..
# Download and install the source version
git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain
sh install.sh
. ./activate
# gui
cd electron-react
npm run build
npm run electron
# Or install from binary wheels
curl -sL https://rpm.nodesource.com/setup_10.x | sudo bash -
sudo yum install -y nodejs
python3.7 -m venv venv
ln -s venv/bin/activate
. ./activate
pip install --upgrade pip
pip install -i https://download.chia.net/simple/ miniupnpc==2.1 setproctitle==1.1.10 cbor2==5.1.2
pip install chia-blockchain==1.0b15
Other install methods and environments
You need Python 3.7 or newer.
Chia strives to provide binary wheels for modern systems. If your system does not have binary wheels, you may need to install development tools to build some Python extensions from source. If you're attempting to install from source, setting the environment variable BUILD_VDF_CLIENT to N will skip trying to build Timelord components that aren't very cross platform, e.g. export BUILD_VDF_CLIENT=N.
Create a virtual environment
Your installation goes inside a virtual environment.
There are lots of ways to create and manage a virtual environment. This is just one.
python3.7 -m venv venv
source venv/bin/activate
pip install --upgrade pip
Wheels can be in source or binary format. Binary wheels are specific to an operating system and python version number. Source wheels require development tools.
Chia hosts some binary wheels that are not available from PyPI. This step is optional, but it may succeed where building from source can take a while or fail in hard-to-debug ways. If wheels are not available for your system, this step will fail. But you can try it anyway.
pip install -i https://hosted.chia.net/simple/ miniupnpc==2.1 setproctitle==1.1.10 cbor2==5.1.2
Install chia-blockchain.
pip install chia-blockchain==1.0b15
Before you use chia-blockchain in future, you must "enter" your virtual environment.
source venv/bin/activate
chia -h