Skip to content

Commit

Permalink
Merge pull request #74 from WadeBarnes/von-network-doc-updates
Browse files Browse the repository at this point in the history
Update von-network related references.
  • Loading branch information
andrewwhitehead committed Jul 16, 2019
2 parents c048481 + 25aa7f7 commit b87c99d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions demo/AriesOpenAPIDemo-DMV.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ To run the demo, you must have a system capable of running docker to run contain

You can also run the agents using Python on your native system, but docker development is sooo much nicer.

Before beginning, clone, or fork and clone this repo and the von-network repo.
Before beginning, clone, or fork and clone this repo and the [von-network](https://github.com/bcgov/von-network) repo.

## Starting Up

To begin the demo, open up three terminal windows, one for each agent - one to run a local Indy network (using the VON network) and one each for the DMV’s Agent and Alice’s Agent. You’ll also open up three browser tabs, one to allow browsing the Indy network ledger, and one for the OpenAPI user interface for each of the agents.

### Start the VON Network

In one of the terminal windows, follow the instructions [here](https://github.com/bcgov/von-network#running-the-network-locally) to start (but don’t stop) a local four-node Indy network. In one of the browser tabs, navigate to [http://localhost:9000](http://localhost:9000) to see the ledger browser user interface and to verify the Indy network is running.
In one of the terminal windows, follow the [Running the Network Locally](https://github.com/bcgov/von-network#running-the-network-locally) instructions to start (but don’t stop) a local four-node Indy network. In one of the browser tabs, navigate to [http://localhost:9000](http://localhost:9000) to see the ledger browser user interface and to verify the Indy network is running.

> NOTE: The use of localhost for the Web interfaces is assumed in this tutorial. If your docker setup is atypical, you may use a different address for your docker host.
Expand Down Expand Up @@ -76,7 +76,7 @@ If all goes well, the agent will show a message indicating it is running. Use th
When you are done, or to stop the demo so you can restart it, carry out the following steps:

1. In the DMV and Alice agent terminal windows, hit Ctrl-C to terminate the agents.
2. In the von-network terminal window, hit Ctrl-C to stop the logging, and then run the command `./manage down` to both stop the network and remove the data on the ledger.
2. In the `von-network` terminal window, hit Ctrl-C to stop the logging, and then run the command `./manage down` to both stop the network and remove the data on the ledger.

### Running the Demo Steps

Expand Down
8 changes: 4 additions & 4 deletions demo/AriesOpenAPIDemo.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ We will get started by getting three browser tabs ready that will be used throug

To run the demo, you must have a system capable of running docker to run containers, and terminal windows running bash. On Windows systems, we highly recommend using git-bash, the Windows Subsystem for Linux (WSL) or a comparable facility. The demo will not work using PowerShell.

Before beginning, clone, or fork and clone this repo and the von-network repo.
Before beginning, clone, or fork and clone this repo and the [von-network](https://github.com/bcgov/von-network) repo.

### Starting Up

To begin the running the demo in Docker, open up three terminal windows, one to run a local Indy network (using the VON network) and one each for the Faber’s and Alice’s agent. You’ll also open up three browser tabs, one to allow browsing the Public Ledger (von-network), and one for the Swagger user interface for each of the agents.
To begin the running the demo in Docker, open up three terminal windows, one to run a local Indy network (using the VON network) and one each for the Faber’s and Alice’s agent. You’ll also open up three browser tabs, one to allow browsing the Public Ledger (`von-network`), and one for the Swagger user interface for each of the agents.

### Start the VON Network

In one of the terminal windows, follow the instructions [here](https://github.com/bcgov/von-network#running-the-network-locally) to start (but don’t stop) a local four-node Indy network. Once the Indy network is running, in one of the browser tabs, navigate to [http://localhost:9000](http://localhost:9000) to see the Public Ledger user interface and to verify the Indy network is running.
In one of the terminal windows, follow the [Running the Network Locally](https://github.com/bcgov/von-network#running-the-network-locally) instructions to start (but don’t stop) a local four-node Indy network. In one of the browser tabs, navigate to [http://localhost:9000](http://localhost:9000) to see the Public Ledger user interface and to verify the Indy network is running.

> NOTE: The use of localhost for the Web interfaces is assumed in this tutorial. If your docker setup is atypical, you may use a different address for your docker host.
Expand Down Expand Up @@ -109,7 +109,7 @@ If all goes well, the agent will show a message indicating it is running. Open a
When you are done, or to stop the demo so you can restart it, carry out the following steps:

1. In the Faber and Alice agent terminal windows, hit Ctrl-C to terminate the agents.
2. In the von-network terminal window, hit Ctrl-C to stop the logging, and then run the command `./manage down` to both stop the network and remove the data on the ledger.
2. In the `von-network` terminal window, hit Ctrl-C to stop the logging, and then run the command `./manage down` to both stop the network and remove the data on the ledger.

## Using the Swagger User Interface

Expand Down
4 changes: 2 additions & 2 deletions demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ Jump to the [Follow the Script](#follow-the-script) section below for further in

### Running in Docker

Running the demo in docker requires having a `von-network` (a Hyperledger Indy public ledger sandbox) instance running in docker locally. See the [von-network](von-https://github.com/bcgov/von-network) readme file for more info.
Running the demo in docker requires having a `von-network` (a Hyperledger Indy public ledger sandbox) instance running in docker locally. See the [Running the Network Locally](https://github.com/bcgov/von-network#running-the-network-locally) section of the `von-network` readme file for more info.

Open three `bash` shells. For Windows users, `git-bash` is highly recommended. bash is the default shell in Linux and Mac terminal sessions.

In the first terminal window, start `von-network` using the instructions provided [here](https://github.com/bcgov/von-network#running-the-network-locally).
In the first terminal window, start `von-network` by following the [Running the Network Locally](https://github.com/bcgov/von-network#running-the-network-locally) instructions.

In the second terminal, change directory into `demo` directory of your clone of this repository. Start the `faber` agent by issuing the following command:

Expand Down

0 comments on commit b87c99d

Please sign in to comment.