Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates from getting started guide #71

Merged
merged 3 commits into from
Apr 12, 2024
+10 −11
Merged

Updates from getting started guide #71

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9264682
Updated did and keri documents reflecting new changes for demo examples
daidoji Apr 5, 2024
62c0b94
Some small updates
daidoji Apr 8, 2024
3324446
Keep these files as is
daidoji Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,12 @@ E.g. using git, Github pages, FTP, SCP, etc.
## Example: serve from docker
You can run the docker example service to serve the did.json and keri.cesr files for the other docker containers:

First, lets copy our generated files to the directory we'll serve from. On your `LOCAL` machine (or within the container) you can copy `volume/dkr/examples/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe` to `volume/dkr/pages/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe`:
First, lets copy our generated files to the directory we'll serve from. On your
`LOCAL` machine (or within the container) you can copy
`volume/dkr/examples/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe` to
`volume/dkr/pages/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe`:

For this demo these files have been copied ahead of time for you.

```
cp -R volume/dkr/examples/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe volume/dkr/pages/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe
Expand All @@ -203,12 +208,6 @@ It will search for AID named directories and for the two files (`did.json` and `
"did.doc.dir": "/usr/local/var/webs/volume/dkr/pages/"
```

And when a file is found by the service, there will be logs like:
```
Looking for did.json file /usr/local/var/webs/volume/dkr/pages/ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe
registering /ENro7uf0ePmiK3jdTo2YCdXLqW7z7xoP6qhhBou6gBLe/did.json
```

It will serve it at a URL that you can CURL from any of our docker containers (for instance from the webs container) like:

`command:`
Expand Down Expand Up @@ -285,7 +284,7 @@ dkr did webs resolve --name resolver --did "did:webs:did-webs-service%3a7676:ENr
### Example: Add designated aliases attestation

Because your AID can be served as a did:webs, did:web, did:keri, etc. identifier you can specify these are designated aliases for verification and discovery purposes.
To create this designated aliases attestation, you can the following:
To create this designated aliases attestation, you can execute the following (on the controller docker image or locally with access to the controller's keystore):

`create credential registry command:`
```
Expand Down Expand Up @@ -321,7 +320,7 @@ You can issue the attestation using the following command, supplying the registr

`command:`
```
kli vc issue --name controller --alias controller --registry-name dAliases --schema EN6Oh5XSD5_q2Hgu-aqpdfbVepdpYpFlgz6zvJL5b_r5 --data @desig-aliases-attr-public.json --rules @desig-aliases-rules-public.json
kli vc create --name controller --alias controller --registry-name dAliases --schema EN6Oh5XSD5_q2Hgu-aqpdfbVepdpYpFlgz6zvJL5b_r5 --data @desig-aliases-attr-public.json --rules @desig-aliases-rules-public.json
```

`output:`
Expand Down Expand Up @@ -602,8 +601,8 @@ and execute the following script:
```

The notable differences now that we are using witnesses:
* The AID is different now `EKYGGh-FtAphGmSZbsuBs_t4qpsjYJ2ZqvMKluq9OxmP`, because the inception event contians the witness information which modifies the data used to generate the AID.
* The DID Document now lists the witnesses in the service endpoints. Note: if you set the metadata flag to true KERI related service endpoints will be in the did document metadata instead of the did document.:
* The AID is different now `EKYGGh-FtAphGmSZbsuBs_t4qpsjYJ2ZqvMKluq9OxmP`, because the inception event contains the witness information which modifies the data used to generate the AID.
* The DID Document now lists the witnesses in the service endpoints. Note, if you set the metadata flag to true, KERI related service endpoints will now be in the did document metadata instead of the did document, as so:
```json
Got DID doc: {
"id": "did:web:did-webs-service%3a7676:EKYGGh-FtAphGmSZbsuBs_t4qpsjYJ2ZqvMKluq9OxmP",
Expand Down
Loading