diff --git a/docs/validators/detailed-instructions.md b/docs/validators/detailed-instructions.md index c8a87518..60326d79 100644 --- a/docs/validators/detailed-instructions.md +++ b/docs/validators/detailed-instructions.md @@ -101,13 +101,13 @@ This assumes the `libra` binary is already built and located at `~/libra-framewo # Copy libra binaries to cargo bins path sudo cp -f ~/libra-framework/target/release/libra* ~/.cargo/bin/ -# Check libra execution and version +# Check libra execution and version libra version ``` -### You will now need [sync your validator to the latest block](/validators/restore) and [register your validator](/validators/register). +### You will now need sync your validator to the latest block and register your validator. #### Start Node diff --git a/docs/validators/getting-started.md b/docs/validators/getting-started.md index fee65d97..e851a8fa 100644 --- a/docs/validators/getting-started.md +++ b/docs/validators/getting-started.md @@ -70,5 +70,5 @@ These measures aim to incentivize consistent and effective network performance b ### How to become a Validator 1. [Configure and setup your machine](/validators/detailed-instructions) -2. [Sync Database to the current version](/validators/restore) -3. [Register your Validator](/validators/register) +2. Sync Database to the current version (TODO: link) +3. [Register your Validator](register) diff --git a/docs/validators/register.todo b/docs/validators/register.md similarity index 94% rename from docs/validators/register.todo rename to docs/validators/register.md index 7c839081..78041033 100644 --- a/docs/validators/register.todo +++ b/docs/validators/register.md @@ -22,12 +22,12 @@ source ~/.bashrc # build and install the binary cd ~/libra-framework -cargo build --release -p libra +cargo build --release -p libra # Make the release path global and persistent sudo cp -f ~/libra-framework/target/release/libra* ~/.cargo/bin/ -# Check libra execution and version +# Check libra execution and version libra --version # ----------------------- @@ -56,7 +56,7 @@ libra txs validator vouch --vouch-for # submit a bid to be in the validator set libra txs validator pof --bid-pct --expiry -# run as a fullnode and switch to the validator mode once entered the set, check the detailed instructions below the page. +# run as a fullnode and switch to the validator mode once entered the set, check the detailed instructions below the page. ``` ## Detailed instructions @@ -132,10 +132,10 @@ libra txs validator register -f ~/.libra/operator.yaml ### Get Vouches 0L Network uses very light reputation games to keep the validator set trusted. -Just ask an existing validator for a vouch. It helps a lot if you share your node specs and a little bit of your experience with them. +Just ask an existing validator for a vouch. It helps a lot if you share your node specs and a little bit of your experience with them. Your friend will: -``` bash +``` bash libra txs validator vouch --vouch-for ``` @@ -147,9 +147,9 @@ libra txs validator pof --bid-pct --expiry ### Run the node as fullnode and then validator mode - Once your validator enters the set you will need to stop running as a fullnode and run as a validator. Until then, you can: - - use the following instructions to: [sync database to the current state](/validators/restore) and run as a fullnode. + - use the following instructions to: sync database to the current state (TODO: link) and run as a fullnode. - When your node is in the active set, it is time to change your node config path to point to the `validator.yaml`. - Stop your node and run in the validator mode: -``` bash +``` bash libra node --config-path ~/.libra/validator.yaml ``` diff --git a/docs/validators/with-docker-setup.md b/docs/validators/with-docker-setup.md index 4b061515..05603574 100644 --- a/docs/validators/with-docker-setup.md +++ b/docs/validators/with-docker-setup.md @@ -6,7 +6,7 @@ description: 'Running a fullnode/vfn/validator node with docker' --- :::danger WIP -This page is a work in progress. +This page is a work in progress. Tread carefully. ::: @@ -121,7 +121,7 @@ docker images | grep openlibra openlibra main b64dbca39f51 9 minutes ago 153MB ``` -## Single IP setup +## Single IP setup ### Create the docker-compose file @@ -134,7 +134,7 @@ Place the following docker-compose.yaml file in the same folder as the Dockerfil x-defaults: &defaults image: "openlibra:main" restart: "on-failure" - pid: host + pid: host ulimits: nproc: 500000 nofile: 500000 @@ -203,7 +203,7 @@ services: - "6182:6182" - "8080:8080" - "9101:9101" - + tower: # needs mnemonic injection <<: *defaults container_name: "0l-tower" @@ -256,7 +256,7 @@ Here is an example of modified `fullnode.yaml` relevant entries: ```bash ... -base: +base: data_dir: '/root/.libra/data' execution: @@ -290,7 +290,7 @@ docker compose logs -f --tail 50 fullnode ``` :::warning If the version is 0 or you're having connectvitiy issues -Do the manual DB restore as described in the [Restore section](/validators/restore#clone-and-build-the-epoch-archive-mainnet-repository) and then [clean and sync](/validators/restore#how-to-clean-the-database-and-sync-to-the-latest-state-again) +Do the manual DB restore as described in the Restore section (TODO: link) and then clean and sync (TODO: link) ::: @@ -298,7 +298,7 @@ Do the manual DB restore as described in the [Restore section](/validators/resto ```bash docker compose run tower -``` +``` @@ -319,7 +319,7 @@ __Dual NIC setup__ Part 1: Configure second IP -Using Netplan (default ubuntu network manager), edit your `/etc/netplan/01-netcfg.yaml` +Using Netplan (default ubuntu network manager), edit your `/etc/netplan/01-netcfg.yaml` Identify your ethernet id (enp5s0 in this example), add the second IP to its addresses list @@ -358,7 +358,7 @@ Under the modified interface, you should see the second IP address link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 inet 127.0.0.1/8 scope host lo valid_lft forever preferred_lft forever - inet6 ::1/128 scope host + inet6 ::1/128 scope host valid_lft forever preferred_lft forever 2: enp5s0: mtu 1500 qdisc fq_codel state UP group default qlen 1000 link/ether c8:7f:tag:tag:tag brd ff:ff:ff:ff:ff:ff @@ -368,6 +368,6 @@ Under the modified interface, you should see the second IP address inet your.secondary.ip.here/32 scope global enp5s0 # <--- make sure second IP appears here valid_lft forever preferred_lft forever ############ - inet6 primary:ip:v:6/64 scope global + inet6 primary:ip:v:6/64 scope global valid_lft forever preferred_lft forever -``` \ No newline at end of file +```