Update documentation
This commit is contained in:
parent
581c486ca4
commit
fdee4786e6
10
README.md
10
README.md
|
@ -2,7 +2,7 @@
|
|||
|
||||
Setup Hive-Engine Super Quick. This is meant for setting up a hive-engine node super quick as long as you know what its doing. It uses the default configuration and is just there to get you setup while you do something else. If you don't understand much about it, don't use it.
|
||||
|
||||
This also does use Node.JS 16 and Mongo 5, which isn't recommended by the official docs. I do run both of those on most of my nodes though and they have worked well for me so it's what I set this script to use(it's mainly for my own use). I'm using Gitea hosted by DBuidl due to IPv6 support for documentation. It auto syncs with github.
|
||||
This also does use Node.JS 18 and Mongo 6, which isn't recommended by the official docs. I do run both of those on most of my nodes though and they have worked well for me so it's what I set this script to use(it's mainly for my own use). I'm using Gitea hosted by DBuidl due to IPv6 support for documentation. It auto syncs with github.
|
||||
|
||||
Usage:
|
||||
```
|
||||
|
@ -22,8 +22,6 @@ This also does use Node.JS 16 and Mongo 5, which isn't recommended by the offici
|
|||
|
||||
-p : Use this to give your hive priv active key. Must provide a value. Default is empty.
|
||||
|
||||
-4 : Use this if you want to use a ipv4 address for your witness. Default is ipv6, and will attempt to failover to v4 if no v6 detected.
|
||||
|
||||
-l : Light node. Use this if you want to run a light node. Default is off(fullnode).
|
||||
|
||||
-s : Give your snapshot location. Must have trailing /. There's 2 possible choices, (https://snap.primersion.com/ and https://snap.rishipanthee.com/snapshots/ which is a mirror of primersion). Default is https://snap.rishipanthee.com/snapshots/.
|
||||
|
@ -34,12 +32,10 @@ Few usage examples:
|
|||
|
||||
Full Node, no witness, default snapshot location : ` ./install.sh`
|
||||
|
||||
Full Node, witness(username rishi556, key 5fake) using ipv6, default snapshot location : ` ./install.sh -w -a rishi556 -p 5fake`
|
||||
|
||||
Full Node, witness(username rishi556, key 5fake) using ipv4, primersion's snapshot location : ` ./install.sh -w -a rishi556 -p 5fake -4 -s https://snap.rishipanthee.com/snapshots/`
|
||||
Full Node, witness(username rishi556, key 5fake), default snapshot location : ` ./install.sh -w -a rishi556 -p 5fake`
|
||||
|
||||
Light Node, no witness, default snapshot location : ` ./install.sh -l`
|
||||
|
||||
Light Node, witness(username rishi556, key 5fake) using ipv6, default snapshot location : ` ./install.sh -w -a rishi556 -p 5fake -l`
|
||||
Light Node, witness(username rishi556, key 5fake), default snapshot location : ` ./install.sh -w -a rishi556 -p 5fake -l`
|
||||
|
||||
Just set the values to what works best for you and run with it. This is meant to be used on a FRESH server.
|
||||
|
|
Loading…
Reference in New Issue