Skip to content

Commit 0586874

Browse files
authored
Merge pull request hyperledger-indy#955 from JanLin/master
Adding trouble shooting guide for GSG
2 parents 2f2d6d4 + a920d5f commit 0586874

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# TROUBLE SHOOTING Getting - Started Guide (GSG)
2+
3+
If you setup the demo and encounter a 307 error recommend to take the following steps to cleanup and start over. The communication with the ledger is affected and it is not possible to run the demo. Here are some recommendations for other errors.
4+
* 306: you already have a configured ledger. Perform clean start.
5+
* 301: you are trying to create a ledger but it is already configured. A single failure will cause a problem when opening the ledger. Perform clean install.
6+
* 212: wallet is not found. When this occur stop and start container: Ctrl-C, docker-compose down, docker-compose up
7+
8+
## Overview steps for clean start
9+
10+
1. Remove existing instances
11+
1. Reset source files
12+
1. Perform a new build
13+
1. Start demo
14+
15+
## Steps in detail
16+
17+
1. Make sure containers are closed
18+
19+
```
20+
docker-compose down # to make sure containers are closed
21+
docker image ls # find image names that need to be removed in next step
22+
docker image rm getting-started
23+
docker image rm indy_pool
24+
docker volume ls # find volume name that needs to be removed in next step
25+
docker volume rm gettingstarted_sandbox
26+
```
27+
28+
2. Reset source files
29+
30+
```git tag # choose the latest version and use it as <branch_name>
31+
git checkout <branch_name>
32+
git reset --hard **WARNING** : make copies of any changes you want to keep prior to taking this step
33+
git fetch --all
34+
git pull
35+
```
36+
37+
3. Perform a new build
38+
39+
```
40+
docker-compose build --no-cache # adding no cache to make clean build
41+
```
42+
43+
4. Start demo
44+
45+
```
46+
docker-compose up
47+
```

doc/getting-started/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -921,3 +921,5 @@ Now that you've had a chance to see how the Libindy implementation works from th
921921
If so, please run [Simulating Getting Started in the Jupiter](run-getting-started.md).
922922
You may need to be signed into GitHub to view this link.
923923
Also you can find the source code [here](https://github.com/hyperledger/indy-sdk/blob/master/samples/python/src/getting_started.py)
924+
925+
If demo gives an error when executing check [Trouble Shooting Guide](Trouble_shoot_GSG.md).

doc/getting-started/run-getting-started.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ To get Jupyter click on the link in output (it must have following format: http:
1818

1919
`docker-compose down`
2020
The command above will stop and delete created network and containers.
21+
22+
### Trouble Shooting
23+
24+
If demo gives an error when executing in Jupyter check [Trouble Shooting Guide](Trouble_shoot_GSG.md).

0 commit comments

Comments
 (0)