Skip to content

Commit

Permalink
Merge pull request #1757 from keep-network/sthompson22/docs/run-rando…
Browse files Browse the repository at this point in the history
…m-beacon-updates

Docs: run-random-beacon Update

A few housekeeping items here:

1. docker run command cleanup. Here we set an entrypoint to
   explicitly override the ENTRYPOINT set in the Dockerfile. Without
   it you will have two --config flags set on the running process running
   the command provided in this doc. Somehow we've turned out ok
   here but it's caused some confusion with testers. Also removed the
   -it arguments from the command as they're not strictly required
   unless you're overriding ENTRYPOINT with bash or sh.
2. Some syntax highlighting motivated by the comments in
   keep-network/keep-ecdsa#396
3. Small text for bootstrap peers. docs.keep.network renders the peers
   on multiple lines without this option set.
  • Loading branch information
Shadowfiend authored May 5, 2020
2 parents 81e15f5 + 24c7897 commit d63ad9c
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions docs/run-random-beacon.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ Application configurations are stored in a `.toml` file and passed to the applic

==== Sample

```
[source,toml]
----
# Ethereum host connection info.
[ethereum]
URL = "ws://127.0.0.1:8546"
Expand Down Expand Up @@ -107,7 +108,7 @@ Application configurations are stored in a `.toml` file and passed to the applic
# Storage is encrypted
[Storage]
DataDir = "/my/secure/location"
```
----

==== Parameters

Expand Down Expand Up @@ -228,19 +229,21 @@ https://hub.docker.com/r/keepnetwork/keep-client/
=== Run Image
This is a sample run command for illustration purposes only.

```
[source,bash]
----
export KEEP_CLIENT_ETHEREUM_PASSWORD=$(cat .secrets/eth-account-password.txt)
export KEEP_CLIENT_CONFIG_DIR=$(pwd)/config
export KEEP_CLIENT_PERSISTENCE_DIR=$(pwd)/persistence
docker run -dit \
docker run -d \
--entrypoint /usr/local/bin/keep-client
--volume $KEEP_CLIENT_PERSISTENCE_DIR:/mnt/keep-client/persistence \
--volume $KEEP_CLIENT_CONFIG_DIR:/mnt/keep-client/config \
--env KEEP_ETHEREUM_PASSWORD=$KEEP_CLIENT_ETHEREUM_PASSWORD \
--env LOG_LEVEL=debug \
-p 3919:3919 \
keep-client --config /mnt/keep-client/config/keep-client-config.toml start
```
keepnetwork/keep-client:<version> --config /mnt/keep-client/config/keep-client-config.toml start
----

== Deployment Considerations

Expand All @@ -262,12 +265,13 @@ network:

=== Configurable Values

```
[source,bash]
----
LOG_LEVEL=DEBUG
IPFS_LOGGING_FMT=nocolor
GOLOG_FILE=/var/log/keep/keep.log
GOLOG_TRACING_FILE=/var/log/keep/trace.json
```
----

=== Startup
```
Expand Down Expand Up @@ -344,9 +348,10 @@ To use the faucet you need to pass your Ethereum account to the faucet endpoint
`?account=<eth-account-address>`.

Curl Example:
```
[source,bash]
----
curl 'https://us-central1-keep-test-f3e0.cloudfunctions.net/keep-faucet-ropsten?account=0x0eC14BC7cCA82c942Cf276F6BbD0413216dDB2bE'
```
----

Browser Example:
```
Expand All @@ -357,7 +362,7 @@ Once you've got your KEEP token grant you can manage it with our https://dashboa

==== Bootstrap Peers

====
[.small]
```
"/dns4/bootstrap-0.test.keep.network/tcp/3919/ipfs/16Uiu2HAmCcfVpHwfBKNFbQuhvGuFXHVLQ65gB4sJm7HyrcZuLttH",
"/dns4/bootstrap-1.test.keep.network/tcp/3919/ipfs/16Uiu2HAm3eJtyFKAttzJ85NLMromHuRg4yyum3CREMf6CHBBV6KY",
Expand All @@ -367,7 +372,6 @@ Once you've got your KEEP token grant you can manage it with our https://dashboa
"/dns4/bootstrap-1.core.keep.test.boar.network/tcp/3001/ipfs/16Uiu2HAkuTUKNh6HkfvWBEkftZbqZHPHi3Kak5ZUygAxvsdQ2UgG",
"/dns4/bootstrap-2.core.keep.test.boar.network/tcp/3001/ipfs/16Uiu2HAmQirGruZBvtbLHr5SDebsYGcq6Djw7ijF3gnkqsdQs3wK"
```
====

==== Contracts

Expand Down

0 comments on commit d63ad9c

Please sign in to comment.