Skip to content

Commit d471c18

Browse files
committed
docs(README): update development instructions
1 parent 506ab21 commit d471c18

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Docker Jolocom Interactions Demo
2+
This is a demo of all interactions supported by the
3+
[JolocomSDK](https://github.com/jolocom/jolocom-sdk). There is a React based
4+
frontend, and a Hapi based backend integrated with the JolocomSDK. It is meant
5+
to be used with the [Jolocom
6+
SmartWallet](https://github.com/jolocom/smartwallet-app)
27

38
A hosted version of this demo is available at https://interxns.jolocom.io
49

@@ -11,13 +16,25 @@ described below
1116
### Service Agent (Backend)
1217
This requires an LTS version of Node: 10 or 12 or 14
1318

19+
The `service_agent` needs to know its "public" facing "host:port" address to be
20+
able to embed it in the interaction tokens, such that the SmartWallet can find
21+
the agent.
22+
23+
To successfully go through the demo while running locally, change the
24+
`SERVICE_HOSTPORT` environment variable that is used in the `yarn start` command
25+
below, to a value that the mobile phone can access, probably the LAN IP address
26+
of the computer that is running the `service_agent`, assuming the test
27+
SmartWallet is on the same LAN
28+
1429
```sh
1530
cd service_agent
1631
yarn install
17-
yarn start
32+
SERVICE_HOSTPORT="192.168.1.42:9000" yarn start
1833
```
1934

2035
### React App (Frontend)
36+
In another terminal:
37+
2138
```sh
2239
cd frontend
2340
yarn install
@@ -26,7 +43,18 @@ yarn start
2643
Visit the frontend development server at http://localhost:3000
2744
and open the Web Console to see debugging output
2845

29-
## Deployment instructions
46+
### Usage with the SmartWallet
47+
48+
The SmartWallet release builds require HTTP**S** connections, and cannot use
49+
plain HTTP. To use this demo without SSL certificates (which is the case if
50+
running in development) please use a **staging** build of the SmartWallet on
51+
Android, available for download here:
52+
https://jolocom.io/wp-content/uploads/smartwallet/smartwallet-staging-1.11.1.apk
53+
54+
## Production Deployment instructions
55+
This demo is not suitable for any sort of "production" deployment, besides use
56+
as a demo.
57+
3058
The repo comes with a [docker-compose.yml](./docker-compose.yml) that is
3159
suitable for deployment accompanied by https://github.com/jolocom/docker-nginx-proxy
3260
which automatically adds HTTPS support by issuing SSL certificates through
@@ -40,18 +68,3 @@ The configuration for the domain is taken from environment variables in
4068
SERVICE_HOSTPORT: 'interxns.jolocom.io'
4169
VIRTUAL_HOST: 'interxns.jolocom.io'
4270
```
43-
44-
### Usage with the SmartWallet
45-
46-
The `service_agent` needs to know its "public" facing "host:port" address to be
47-
able to embed it in the interaction tokens, such the the SmartWallet can find
48-
the agent.
49-
50-
To successfully go through the demo, change the `SERVICE_HOSTPORT` environment
51-
variable inside `docker-compose.yml` to a value that the mobile phone can
52-
access, probably the LAN IP address of the computer running the `service_agent`,
53-
assuming the test SmartWallet is on the same LAN
54-
55-
Also note that the SmartWallet release builds require HTTP**S** connections, and cannot use
56-
plain HTTP. To use this demo without SSL certificates please use a **staging**
57-
build of the SmartWallet on Android, available for download here: https://jolocom.io/wp-content/uploads/smartwallet/smartwallet-staging-1.11.1.apk

0 commit comments

Comments
 (0)