Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reConNico/ark-failover
ARK-Failover script for https://github.com/ArkEcosystem/ark-node
https://github.com/reConNico/ark-failover
Last synced: 4 days ago
JSON representation
ARK-Failover script for https://github.com/ArkEcosystem/ark-node
- Host: GitHub
- URL: https://github.com/reConNico/ark-failover
- Owner: reConNico
- License: mit
- Archived: true
- Created: 2017-12-25T13:24:14.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2018-05-02T07:11:31.000Z (over 6 years ago)
- Last Synced: 2024-04-13T10:26:57.582Z (7 months ago)
- Language: Shell
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ark - Ark-Failover - Failover script for ark-node (Delegate Tools / Mobile)
README
# ARK-Failover
## Requirements
To run the failover script you need 3 standalone servers. For the documentation we used the following names:
* master (runs the failover script with ssh connection to nodes)
* relay-1 (running ark-node who is currently forging)
* relay-2 (running ark-node who isn't forging right now. Node needs to be in sync!)
#### Tutorials
* [How to setup an ark node](https://github.com/ArkEcosystem/docs/blob/master/system_administration/01_SetupArkNode.md)
* [How to secure your ark node](https://github.com/ArkEcosystem/docs/blob/master/system_administration/02_SecureYourArkNode.md)
* [How to set your nodes as ssh host on the master node](https://www.digitalocean.com/community/tutorials/how-to-configure-custom-connection-options-for-your-ssh-client)
**Both nodes (forging and relay) must have [noah](https://github.com/faustbrian/noah) installed correctly.** Note that `noah` **shouldn't** be running on these nodes, it just has to be installed!
The first relay needs to be the current forging delegate node. The second relay needs to be a running ark-node that doesn't forge.
The master node only need to run the failover script and have a functioning ssh connection to both nodes.
## Installation
* `git clone https://github.com/reconnico/ark-failover.git`
* `cd ~/ark-failover`
* `bash failover.sh install` (if the error `No such file or directory` occurs please run `sudo updatedb`)
## Configuration
* create `secret.txt` file and insert your secret. Check `secret.sample.txt` for an example.
* create `nodes.txt` file and set your nodes `forging;relay`. Use ssh host names of your nodes here. Check `nodes.sample.txt` for an example.
* `bash failover.sh test` (If an error occur please repeat the last 2 steps and check your configuration)
* `bash failover.sh start`
* modify vars in `variables.sh`. Example, change `network` to either `mainnet` or `devnet` (it's set to `devnet` by default), also double check if paths are set correctly.
## Commands
```bash
Usage: failover.sh [options]
options:
help Show help information.
install Install the application.
start Start the application.
stop Stop the application.
restart Restart the application.
test Test the application.
switch Switch the forging node.
rebuild [node] Rebuild a node using noah.
update Update the application to the latest version.
nodes Display current nodes information.
status Display the status of the application.
log Show log information.
alias Create a bash alias for failover.
```
## Testing on devnet
We recommend you to test the setup on a test environment first.
* change the network variable in `variables.sh` to `devnet`
* change your secret in `secret.txt` to your devnet delegate secret
* edit `nodes.txt` and set your nodes `forging;relay` (use ssh host names of your nodes here)
## Credits
* [Nico Allers](https://github.com/reconnico)
* [Brian Faust](https://github.com/faustbrian) Developer of [noah](https://github.com/faustbrian/noah)
* [Contributors](https://github.com/reconnico/ark-failover/graphs/contributors)
## License
[MIT](LICENSE) © Nico Allers