Skip to content

Commit 4c22b71

Browse files
swcurranjamshale
andauthored
Cleanup markdown errors in docs/demo/readme (openwallet-foundation#3734)
Signed-off-by: Stephen Curran <swcurran@gmail.com> Co-authored-by: jamshale <31809382+jamshale@users.noreply.github.com>
1 parent b82fe15 commit 4c22b71

1 file changed

Lines changed: 34 additions & 32 deletions

File tree

docs/demo/README.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ There are several demos available for ACA-Py mostly (but not only) aimed at deve
2424
- [Mediation](#mediation)
2525
- [Multi-ledger](#multi-ledger)
2626
- [Multi-tenancy](#multi-tenancy)
27-
- [Multi-tenancy *with Mediation*!!!](#multi-tenancy-with-mediation)
27+
- [Multi-tenancy *with Mediation*](#multi-tenancy-with-mediation)
2828
- [Other Environment Settings](#other-environment-settings)
2929
- [Learning about the Alice/Faber code](#learning-about-the-alicefaber-code)
3030
- [OpenAPI (Swagger) Demo](#openapi-swagger-demo)
@@ -169,7 +169,7 @@ With both the Alice and Faber agents started, go to the Faber terminal window. T
169169

170170
Faber:
171171

172-
```
172+
``` text
173173
(1) Issue Credential
174174
(1a) Set Credential Type (indy)
175175
(2) Send Proof Request
@@ -181,7 +181,7 @@ Faber:
181181

182182
Alice:
183183

184-
```
184+
``` text
185185
(3) Send Message
186186
(4) Input New Invitation
187187
(X) Exit?
@@ -205,7 +205,7 @@ You can enable support for various ACA-Py features by providing additional comma
205205

206206
Note that when the controller starts up the agent, it prints out the ACA-Py startup command with *all* parameters - you can inspect this command to see what parameters are provided in each case. For more details on the parameters, just start ACA-Py with the `--help` parameter, for example:
207207

208-
```
208+
``` bash
209209
./scripts/run_docker start --help
210210
```
211211

@@ -223,7 +223,7 @@ You need to run an AnonCreds revocation registry tails server in order to suppor
223223

224224
Faber will setup support for revocation automatically, and you will see an extra option in faber's menu to revoke a credential:
225225

226-
```
226+
``` text
227227
(1) Issue Credential
228228
(1a) Set Credential Type (indy)
229229
(2) Send Proof Request
@@ -235,18 +235,18 @@ Faber will setup support for revocation automatically, and you will see an extra
235235
(8) List Revocation Registries
236236
(T) Toggle tracing on credential/proof exchange
237237
(X) Exit?
238-
```
238+
```
239239

240240
When you issue a credential, make a note of the `Revocation registry ID` and `Credential revocation ID`:
241241

242-
```
242+
``` text
243243
Faber | Revocation registry ID: WGmUNAdH2ZfeGvacFoMVVP:4:WGmUNAdH2ZfeGvacFoMVVP:3:CL:38:Faber.Agent.degree_schema:CL_ACCUM:15ca49ed-1250-4608-9e8f-c0d52d7260c3
244244
Faber | Credential revocation ID: 1
245245
```
246246

247247
When you revoke a credential you will need to provide those values:
248248

249-
```
249+
``` text
250250
[1/2/3/4/5/6/7/8/T/X] 5
251251
252252
Enter revocation registry ID: WGmUNAdH2ZfeGvacFoMVVP:4:WGmUNAdH2ZfeGvacFoMVVP:3:CL:38:Faber.Agent.degree_schema:CL_ACCUM:15ca49ed-1250-4608-9e8f-c0d52d7260c3
@@ -282,7 +282,7 @@ This is described in [Endorser.md](Endorser.md)
282282

283283
To enable mediation, run the `alice` or `faber` demo with the `--mediation` option:
284284

285-
```bash
285+
``` bash
286286
./run_demo faber --mediation
287287
```
288288

@@ -292,7 +292,7 @@ This will start up a "mediator" agent with Alice or Faber and automatically set
292292

293293
To enable multiple ledger mode, run the `alice` or `faber` demo with the `--multi-ledger` option:
294294

295-
```bash
295+
``` bash
296296
./run_demo faber --multi-ledger
297297
```
298298

@@ -302,7 +302,7 @@ The configuration file for setting up multiple ledgers (for the demo) can be fou
302302

303303
To enable support for multi-tenancy, run the `alice` or `faber` demo with the `--multitenant` option:
304304

305-
```bash
305+
``` bash
306306
./run_demo faber --multitenant
307307
```
308308

@@ -312,7 +312,7 @@ You will see an additional menu option to create new sub-wallets (or they can be
312312

313313
Faber:
314314

315-
```
315+
``` text
316316
(1) Issue Credential
317317
(1a) Set Credential Type (indy)
318318
(2) Send Proof Request
@@ -325,7 +325,7 @@ Faber:
325325

326326
Alice:
327327

328-
```
328+
``` text
329329
(3) Send Message
330330
(4) Input New Invitation
331331
(W) Create and/or Enable Wallet
@@ -334,7 +334,7 @@ Alice:
334334

335335
When you create a new wallet, you just need to provide the wallet name. (If you provide the name of an existing wallet then the controller will "activate" that wallet and make it the current wallet.)
336336

337-
```
337+
``` text
338338
[1/2/3/4/W/T/X] w
339339
340340
Enter wallet name: new_wallet_12
@@ -353,15 +353,15 @@ Once you have created a new wallet, you must establish a connection between `ali
353353

354354
In faber, create a new invitation:
355355

356-
```
356+
``` text
357357
[1/2/3/4/W/T/X] 4
358358
359359
(... creates a new invitation ...)
360360
```
361361

362362
In alice, accept the invitation:
363363

364-
```
364+
``` text
365365
[1/2/3/4/W/T/X] 4
366366
367367
(... enter the new invitation string ...)
@@ -383,15 +383,15 @@ Note that with multi-tenancy enabled:
383383

384384
Documentation on ACA-Py's multi-tenancy support can be found [here](https://github.com/openwallet-foundation/acapy/blob/main/docs/features/Multitenancy.md).
385385

386-
### Multi-tenancy *with Mediation*!!!
386+
### Multi-tenancy *with Mediation*
387387

388388
There are two options for configuring mediation with multi-tenancy, documented [here](https://github.com/openwallet-foundation/acapy/blob/main/docs/features/Multitenancy.md#mediation).
389389

390390
This demo implements option #2 - each sub-wallet is configured with a separate connection to the mediator.
391391

392392
Run the demo (Alice or Faber) specifying *both* options:
393393

394-
```bash
394+
``` bash
395395
./run_demo faber --multitenant --mediation
396396
```
397397

@@ -403,27 +403,29 @@ The agents run on a pre-defined set of ports, however occasionally your local sy
403403

404404
To override the default port settings:
405405

406-
```bash
406+
``` bash
407407
AGENT_PORT_OVERRIDE=8010 ./run_demo faber
408408
```
409409

410410
(The agent requires up to 10 available ports.)
411411

412412
To pass extra arguments to the agent (for example):
413413

414-
```bash
414+
``` bash
415415
DEMO_EXTRA_AGENT_ARGS="[\"--emit-did-peer-2\"]" ./run_demo faber --did-exchange --reuse-connections
416416
```
417417

418418
Additionally, separating the build and run functionalities in the script allows for smoother development and debugging processes. With the mounting of volumes from the host into the Docker container, code changes can be automatically reloaded without the need to repeatedly build the demo.
419419

420420
Build Command:
421-
```bash
421+
422+
``` bash
422423
./demo/run_demo build alice --wallet-type askar-anoncreds --events
423424
```
424425

425426
Run Command:
426-
```bash
427+
428+
``` bash
427429
./demo/run_demo run alice --wallet-type askar-anoncreds --events
428430
```
429431

@@ -443,16 +445,16 @@ Another example in the `demo/runners` folder is [performance.py](https://github.
443445

444446
To run the demo, make sure that you shut down any running Alice/Faber agents. Then, follow the same steps to start the Alice/Faber demo, but:
445447

446-
* When starting the first agent, replace the agent name (e.g. `faber`) with `performance`.
447-
* Don't start the second agent (`alice`) at all.
448+
- When starting the first agent, replace the agent name (e.g. `faber`) with `performance`.
449+
- Don't start the second agent (`alice`) at all.
448450

449451
The script starts both agents, runs the performance test, spits out performance results and shuts down the agents. Note that this is just one demonstration of how performance metrics tracking can be done with ACA-Py.
450452

451453
A second version of the performance test can be run by adding the parameter `--routing` to the invocation above. The parameter triggers the example to run with Alice using a routing agent such that all messages pass through the routing agent between Alice and Faber. This is a good, simple example of how routing can be implemented with DIDComm agents.
452454

453455
You can also run the demo against a postgres database using the following:
454456

455-
```bash
457+
``` bash
456458
./run_demo performance --arg-file demo/postgres-indy-args.yml
457459
```
458460

@@ -462,27 +464,27 @@ You can tweak the number of credentials issued using the `--count` and `--batch`
462464

463465
An example full set of options is:
464466

465-
```bash
467+
``` bash
466468
./run_demo performance --arg-file demo/postgres-indy-args.yml -c 10000 -b 10 --wallet-type askar
467469
```
468470

469471
Or:
470472

471-
```bash
473+
``` bash
472474
./run_demo performance --arg-file demo/postgres-indy-args.yml -c 10000 -b 10 --wallet-type indy
473475
```
474476

475477
## Coding Challenge: Adding ACME
476478

477479
Now that you have a solid foundation in using ACA-Py, time for a coding challenge. In this challenge, we extend the Alice-Faber command line demo by adding in ACME Corp, a place where Alice wants to work. The demo adds:
478480

479-
* ACME inviting Alice to connect
480-
* ACME requesting a proof of her College degree
481-
* ACME issuing Alice a credential after she is hired.
481+
- ACME inviting Alice to connect
482+
- ACME requesting a proof of her College degree
483+
- ACME issuing Alice a credential after she is hired.
482484

483485
The framework for the code is in the [acme.py](https://github.com/openwallet-foundation/acapy/tree/main/demo/runners/acme.py) file, but the code is incomplete. Using the knowledge you gained from running demo and viewing the alice.py and faber.py code, fill in the blanks for the code. When you are ready to test your work:
484486

485-
* Use the instructions above to start the Alice/Faber demo (above).
486-
* Start another terminal session and run the same commands as for "Alice", but replace "alice" with "acme".
487+
- Use the instructions above to start the Alice/Faber demo (above).
488+
- Start another terminal session and run the same commands as for "Alice", but replace "alice" with "acme".
487489

488490
All done? Checkout how we added the missing code segments [here](AcmeDemoWorkshop.md).

0 commit comments

Comments
 (0)