oceanprotocol/barge
1
0
Fork 0
mirror of https://github.com/oceanprotocol/barge.git synced 2024-12-02 05:57:21 +01:00
Code Releases Activity

Merge pull request #73 from oceanprotocol/update/readme

Browse Source 
Update the readme file to make it clear what is required to setup before running start_ocean.
This commit is contained in:
Samer 2018-12-03 19:30:17 +01:00 committed by GitHub
commit 3210dc7b72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -31,6 +31,9 @@ You need to have the newest versions available of both:
* [Docker](https://www.docker.com/get-started) * [Docker](https://www.docker.com/get-started)
* [Docker Compose](https://docs.docker.com/compose/) * [Docker Compose](https://docs.docker.com/compose/)
Populate the following in `brizo.env` file:
* All of the `AZURE_`... related variables: necessary for `Brizo` to serve consume requests
## Get Started ## Get Started
Then bring up an instance of the whole Ocean Protocol network stack with the `start_ocean.sh` script: Then bring up an instance of the whole Ocean Protocol network stack with the `start_ocean.sh` script:
@ -48,6 +51,8 @@ This will bring up the `stable` versions of all components, referring to their r
To get the `latest` versions of all components, referring to their `develop` branches, pass the argument `--latest`: To get the `latest` versions of all components, referring to their `develop` branches, pass the argument `--latest`:
To run as a publisher, `Brizo` configuration must be set with valid Azure account credentials. This is done in
```bash ```bash
./start_ocean.sh --latest ./start_ocean.sh --latest
``` ```
@ -117,12 +122,15 @@ then the last-selected Docker Compose file will be used, i.e. the one selected b
If you run the `start_ocean.sh` script with the `--local-parity-node` option, you will have available a Parity Client instance with the following accounts enabled: If you run the `start_ocean.sh` script with the `--local-parity-node` option, you will have available a Parity Client instance with the following accounts enabled:
Account | Password | Balance Account | Password | Balance
--------|----------|-------- --------|----------|--------
0x00bd138abd70e2f00903268f3db08f2d25677c9e | node0 | 10000000111000111000111000 0x00bd138abd70e2f00903268f3db08f2d25677c9e | node0 | 10000000111000111000111000
0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0 | secret | 100000000 0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0 | secret | 100000000
0xa99d43d86a0758d5632313b8fa3972b6088a21bb | secret | 100000000 0xa99d43d86a0758d5632313b8fa3972b6088a21bb | secret | 100000000
Use one of the above accounts to populate `PARITY_ADDRESS` and `PARITY_PASSWORD` in `brizo.env` file to avoid asccount `locked` issues from the keeper contracts.
### Environment Variables ### Environment Variables
The `start_ocean.sh` script and `.env` file sets defaults for the following environment variables but you can use these in combination with the Docker Compose files for further customization, e.g.: The `start_ocean.sh` script and `.env` file sets defaults for the following environment variables but you can use these in combination with the Docker Compose files for further customization, e.g.:
@ -139,7 +147,7 @@ Variable | Description
`KEEPER_NETWORK_NAME` | set to one of `"ganache"` (default), `"kovan"`, or `"ocean_poa_net_local"` `KEEPER_NETWORK_NAME` | set to one of `"ganache"` (default), `"kovan"`, or `"ocean_poa_net_local"`
`ARTIFACTS_FOLDER` | this is where the deployed smart contracts abi files will be available. This can be pointed at any path you like. `ARTIFACTS_FOLDER` | this is where the deployed smart contracts abi files will be available. This can be pointed at any path you like.
In addition to these variables, when running Brizo you need to provide the Azure credentials to allow Brizo connect to Azure. These variables can be configured in the file `brizo.env`. In addition to these variables, when running Brizo you need to provide the Azure credentials to allow Brizo to connect to Azure. These variables can be configured in the file `brizo.env`.
## Contributing ## Contributing

4
brizo.env
View File

@ -7,8 +7,8 @@ KEEPER_NETWORK_NAME=ocean_poa_net_local
SECRET_STORE_URL=http://secret-store:12001 SECRET_STORE_URL=http://secret-store:12001
PARITY_URL=http://parity-node:8545 PARITY_URL=http://parity-node:8545
# Set a valid parity address and password to have seamless interaction with the `keeper` # Set a valid parity address and password to have seamless interaction with the `keeper`
PARITY_ADDRESS= PARITY_ADDRESS=0x00bd138abd70e2f00903268f3db08f2d25677c9e
PARITY_PASSWORD= PARITY_PASSWORD=node0
AQUARIUS_URL=http://aquarius:5000 AQUARIUS_URL=http://aquarius:5000
BRIZO_URL=http://brizo:8030 BRIZO_URL=http://brizo:8030