diff --git a/README.md b/README.md index 32cbaa6fd50dc72ec83e338ed0980a3ca331bf8d..f7528a42a84de4c754b9bf456669bb9085494e3f 100644 --- a/README.md +++ b/README.md @@ -3,30 +3,21 @@ ## Website: https://www.bfa.ar/ ## Repo: https://gitlab.bfa.ar/blockchain/nucleo.git -1. Install geth - - For Debian read doc/compiling-geth-on-debian.txt - - For Ubuntu read doc/installing-geth-on-ubuntu.txt -2. Install packages: - - `sudo apt-key adv --keyserver keyserver.ubuntu.com --recv 68576280` - - `sudo apt-add-repository "deb https://deb.nodesource.com/node_7.x $(lsb_release -sc) main"` - - `sudo apt-get update` - - `sudo apt install jq ncurses-bin curl` - - `sudo apt-get install nodejs` - - `npm init -y` - - `npm install web3` -3. Install the BFA software: - - `git clone https://gitlab.bfa.ar/blockchain/nucleo.git` -4. `source ${HOME}/bfa/bin/env` - - You can include this line in your .bash_profile if you want. It is perfectly safe to source it multiple times. - - `echo 'source ${HOME}/bfa/bin' > ~/.bashrc` -5. Add crontab to start on system reboot (if you are running a sealer you MUST do this): - - `crontab -l 2>/dev/null | (grep -v bfa/bin/cron ; echo '@reboot bfa/bin/cron.sh') | crontab -` -6. run `start.sh`. This will start synchronizing and takes some time. This is normally done from cron on system restart. +1. Install `git` + - `sudo apt install git` +2. Clone the official BFA repository + - `git clone https://gitlab.bfa.ar/blockchain/nucleo.git bfa` +3. Install the installation script. This will change settings on your system. If you are worried (you should be?), then you could run this step by step manually. + - run `bfa/bin/installbfa.sh` +4. Switch to user `bfa` + - run `sudo su - bfa` +5. Start synchronizing. Synchronizing can take a while. This script is automatically run at system restart. + - run `start.sh` 7. Monitor the logs with `bfalog.sh`. Press CTRL-C at any time to stop the `tail -f`. -7. Change your node's settings with `syncmode.sh` +8. Change your node's settings with `syncmode.sh` - Do this before you have synced too much in the step before, as it might remove all your downloaded chain data and restart synchronizing the chain. -8. Wait for it to finish synchronizing. -9. Run `maymine.sh` to update your configuration (detects if you are allowed to seal/mine or not). You can run this as often as you wish. If you try to mine/seal but is not allowed, your log will show errors (but no harm done). +9. Wait for it to finish synchronizing. +10. Run `maymine.sh` to update your configuration (detects if you are allowed to seal/mine or not). You can run this as often as you wish. If you try to mine/seal but is not allowed, your log will show errors (but no harm done). 11. Simple super basic tools (more actual proof of concepts, to inspire programmers): - `explorer.sh` : It follows "latest" by default, but you can specify a block number as argument, e.g. `explorer.sh 0` to see genesis (block 0). - `walker.pl` : Also takes a blocknumber to start from. Keeps waiting for new blocks.