Move attestation service instructions to main page #2051
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timmoreton
reviewed
Dec 4, 2019
| @@ -512,7 +515,108 @@ You can now run the node for the attestation service in the background: | |||
| docker run --name celo-attestations --restart always -p 8545:8545 -v $PWD:/root/.celo $CELO_IMAGE --verbosity 3 --networkid $NETWORK_ID --syncmode full --rpc --rpcaddr 0.0.0.0 --rpcapi eth,net,web3,debug,admin --unlock $CELO_ATTESTATION_SIGNER_ADDRESS | |||
| ``` | |||
|
|
|||
| By now, you should have setup your Validator account appropriately. You can finish the actual deploy of the attestation service under the [Attestation Service at the documentation page](running-attestation-service.md). | |||
| A part of that we are going to setup the following environment variable about the Attestation Service Docker image: | |||
There was a problem hiding this comment.
typos -- maybe Next we will set up the Attestation Service itself. First, specify the following environment variables:
also, could use some explanation that the "node" is different from the Attestation Service....
| export CELO_PROVIDER=http://localhost:8545 | ||
| ``` | ||
|
|
||
| ### Sms Providers |
|
|
||
| ### Sms Providers | ||
|
|
||
| Currently the Sms providers supported are Nexmo & Twilio. You can create your user account in the provider of your election using the [Nexmo Sign Up form](https://dashboard.nexmo.com/sign-up) or the [Twilio Sign Up form](https://www.twilio.com/try-twilio). |
There was a problem hiding this comment.
and let's give users a steer if there's a reason to do so
| | TWILIO_BLACKLIST | A comma-sperated list of country codes you do not want to serve | | ||
|
|
||
| After you signed up for Twilio at [https://www.twilio.com/try-twilio](https://www.twilio.com/try-twilio), you should see your `ACCOUNT SID` and your `AUTH_TOKEN` in the top right of the console. You'll also want to enter in a credit card to fund the account. For most text messages, the costs will be very low. Find a more comprehensive price list at [https://www.twilio.com/sms/pricing](https://www.twilio.com/sms/pricing). If there are countries that you do not want to serve, you can specify them with the `TWILIO_BLACKLIST`. | ||
|
|
There was a problem hiding this comment.
with the TWILIO_BLACKLIST. -> cut the
| celocli account:get-metadata $CELO_VALIDATOR_ADDRESS | ||
| ``` | ||
|
|
||
| By now, you should have setup your Validator account appropriately. |
There was a problem hiding this comment.
Links to show metadata and attestation stats on blockscout?
There was a problem hiding this comment.
Beyond the cli account cmd we don't really have anything. And the stats will just show 0?
There was a problem hiding this comment.
but you can let them know their metadata link will be visible there, and that the stats will update in the future
|
nearly 👍 |
Codecov Report
@@ Coverage Diff @@
## master #2051 +/- ##
=======================================
Coverage 74.43% 74.43%
=======================================
Files 281 281
Lines 7822 7822
Branches 974 974
=======================================
Hits 5822 5822
Misses 1883 1883
Partials 117 117
Continue to review full report at Codecov.
|
timmoreton
approved these changes
Dec 5, 2019
aaronmgdr
added a commit
that referenced
this pull request
Dec 5, 2019
* master: (27 commits) Experience Brand Kit 1.0 (#1948) Adjust reference to the rewards app (#2065) [Wallet] Compatibility with exchange rate in string format (#2060) Fix Typo in CI config (#2056) Fix additional attestations instructions (#2057) Allow a specified address to disable/enable rewards distribution (#1828) Aaronmgdr/leaderboard patch (#2055) Move attestation service instructions to main page (#2051) Point To Updated Join Celo Video (#2052) Fix minor issue withe the ordering of instructions changes to docs related to discovery (#2025) [Docs] Fix typos in Running a Validator docs (#2045) Add node flag to celocli to set the target node for a single command (#2020) Fix broken links and spruce up CLI docs for accounts command (#2027) Prevent clipping of arrow component (#2036) Allocates an initial balance to the attestation bot (#2019) gold and dollar flags are required for faucet script (#1943) Clean seed words text area when returns from empty wallet view (#1904) Update validator script (#2026) Docs: PoS, metadata, gateway fee plus cleanup (#2022) ...
aaronmgdr
added a commit
that referenced
this pull request
Dec 5, 2019
* master: (208 commits) Fix potential hard timeouts (#2072) Add checkzero,blockscout,mulit-address support to faucet. Fix broken envType checks (#2068) README added mission (#1972) Add dev-utils README (#2081) Add validator:status command to check if a validator signer is online and producing blocks (#1906) Experience Brand Kit 1.0 (#1948) Adjust reference to the rewards app (#2065) [Wallet] Compatibility with exchange rate in string format (#2060) Fix Typo in CI config (#2056) Fix additional attestations instructions (#2057) Allow a specified address to disable/enable rewards distribution (#1828) Aaronmgdr/leaderboard patch (#2055) Move attestation service instructions to main page (#2051) Point To Updated Join Celo Video (#2052) Fix minor issue withe the ordering of instructions changes to docs related to discovery (#2025) [Docs] Fix typos in Running a Validator docs (#2045) Add node flag to celocli to set the target node for a single command (#2020) Fix broken links and spruce up CLI docs for accounts command (#2027) Prevent clipping of arrow component (#2036) ... # Conflicts: # packages/web/src/layout/BookLayout.tsx # packages/web/src/lib.dom.d.ts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
It was not obvious that you are supposed to run the attestation service, so this PR moves the instructions back onto the main page