bosagora / agora

POC Node implementation for CoinNet
https://bosagora.io
MIT License
37 stars 23 forks source link

Add `ngrok` usage to README #3260

Closed linked0 closed 2 years ago

linked0 commented 2 years ago

We provide the way to use ngrok when running Agora as a Validator on a home server.

After this, I will add the instructions for the Korean README.

Fixes #3241

codecov[bot] commented 2 years ago

Codecov Report

Merging #3260 (9894fc3) into v0.x.x (3a0ed30) will increase coverage by 35.54%. The diff coverage is n/a.

@@             Coverage Diff             @@
##           v0.x.x    #3260       +/-   ##
===========================================
+ Coverage   53.57%   89.12%   +35.54%     
===========================================
  Files         332      165      -167     
  Lines       35829    17032    -18797     
===========================================
- Hits        19196    15179     -4017     
+ Misses      16633     1853    -14780     
Flag Coverage Δ
integration 44.63% <ø> (+20.88%) :arrow_up:
unittests 87.61% <ø> (-0.05%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
source/agora/common/FileBasedLock.d 0.00% <0.00%> (-72.73%) :arrow_down:
source/agora/test/NetworkDiscovery.d 84.09% <0.00%> (-4.55%) :arrow_down:
source/agora/consensus/state/ValidatorSet.d 85.71% <0.00%> (-1.06%) :arrow_down:
source/agora/node/Validator.d 91.45% <0.00%> (-0.51%) :arrow_down:
source/agora/common/DNS.d 87.96% <0.00%> (-0.40%) :arrow_down:
source/agora/consensus/state/Ledger.d 90.60% <0.00%> (-0.34%) :arrow_down:
source/agora/node/main.d 44.85% <0.00%> (ø)
agora/submodules/configy/source/configy/Read.d
agora/submodules/vibe.d/web/vibe/web/web.d
...bmodules/vibe.d/mongodb/vibe/db/mongo/connection.d
... and 172 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3a0ed30...9894fc3. Read the comment docs.

linked0 commented 2 years ago

Updated and applied it to the Korean README. Will merge this PR with @hewison-chris's approval as I have checked the content with a spell check program once more.