Skip to content

Commit 5d8c227

Browse files
docs(readme): update dome key generator images
1 parent 782bbba commit 5d8c227

File tree

4 files changed

+30
-22
lines changed

4 files changed

+30
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -170,15 +170,23 @@ LEARCredentialMachine. In the ticket text, add the following data:
170170
- Organization id (VAT number):
171171
- Country:
172172

173-
d. Email address to which you wish to receive the LEARCredentialMachine:
173+
d. Email address to which you wish to receive the LEARCredentialMachine.
174174

175-
2. Go to the [DOME Key Generator](https://dome-marketplace.github.io/dome-crypto-generator/):
175+
2. Wait until you receive in your email address:
176+
- The **LEARCredentialMachine** in Base64 format.
177+
- The **Desmos private key**.
178+
- Your **Did-key**.
179+
180+
3. Go to the [DOME Key Generator](https://dome-marketplace.github.io/dome-crypto-generator/):
176181
![dome-key-generator-home.png](doc/dome-key-generator-home.png)
177182

178-
3. Click the button to generate the keys:
183+
6. Write the Did-key received:
184+
![dome-key-generator-did-key.png](doc/dome-key-generator-did-key.png)
185+
186+
4. Click the button to generate the keys:
179187
![dome-key-generator-example.png](doc/dome-key-generator-example.png)
180188

181-
4. Register as a valid organization in the Trusted Access Node List of the corresponding environment following the
189+
6. Register as a valid organization in the Trusted Access Node List of the corresponding environment following the
182190
instructions in the [DOME Trust Framework](https://github.com/DOME-Marketplace/trust-framework).
183191

184192
:bulb: With the following tables you can relate the key names in the Dome Key Generator with the key names in the
@@ -188,7 +196,7 @@ LEARCredentialMachine. In the ticket text, add the following data:
188196
|--------------------------|---------------------------|
189197
| dlt_address | DLT keys -> DLT Address |
190198

191-
5. Register as a valid service in the Trusted Services List of the corresponding environment following the
199+
7. Register as a valid service in the Trusted Services List of the corresponding environment following the
192200
instructions provided in the [DOME Trust Framework](https://github.com/DOME-Marketplace/trust-framework).
193201
Use the following YAML template as a reference:
194202
```
@@ -204,12 +212,12 @@ LEARCredentialMachine. In the ticket text, add the following data:
204212
tokenEndpointAuthenticationSigningAlgorithm: "ES256"
205213
```
206214
> [!NOTE]
207-
> Replace `<did:key>` with the DID key generated in the "Desmos keys" part of the DOME Key Generator.
215+
> Replace `<did:key>` with the DID key provided in the credential issuance.
208216
209-
6. Copy the LEARCredentialMachine in Base64 format and paste it in the `learCredentialMachineInBase64` field in the
217+
8. Copy the LEARCredentialMachine in Base64 format and paste it in the `learCredentialMachineInBase64` field in the
210218
Access Node Helm Chart implementation.
211219
212-
7. Copy the private keys to your Access Node Helm Chart implementation and update the specified fields
220+
9. Copy the private keys to your Access Node Helm Chart implementation and update the specified fields
213221
in [How to configure](#how-to-configure) section.
214222
You have a specific explanation about what you need to add in the Trusted Access Node List
215223
in: https://github.com/DOME-Marketplace/trust-framework#which-data-is-needed-to-set-a-new-entry-into-the-trusted-access-node-operators-list.
@@ -224,25 +232,25 @@ LEARCredentialMachine. In the ticket text, add the following data:
224232
| dlt-adapter.env.PRIVATE_KEY | DLT keys -> Private Key |
225233
| dlt-adapter.env.ISS | DLT keys -> ISS |
226234
227-
8. Add the DOME Helm Chart Repository to your helm installation
235+
10. Add the DOME Helm Chart Repository to your helm installation
228236
229-
```
230-
helm repo add dome-access-node https://dome-marketplace.github.io/access-node
231-
helm repo update
232237
```
238+
helm repo add dome-access-node https://dome-marketplace.github.io/access-node
239+
helm repo update
240+
```
233241
234-
:bulb: All releases of the Access-Node reside in the
235-
helm-repository https://dome-marketplace.github.io/access-node.
236-
In addition to that, all Pre-Release versions(build from the Pull Requests) are provided in the
237-
pre-repo https://dome-marketplace.github.io/access-node/pre. The pre-repo will be cleaned-up from time to time, in
238-
order to keep the index manageable.
242+
:bulb: All releases of the Access-Node reside in the
243+
helm-repository https://dome-marketplace.github.io/access-node.
244+
In addition to that, all Pre-Release versions(build from the Pull Requests) are provided in the
245+
pre-repo https://dome-marketplace.github.io/access-node/pre. The pre-repo will be cleaned-up from time to time, in
246+
order to keep the index manageable.
239247
240-
9. Install the DOME Access Node
241-
```
242-
helm install access-node dome-access-node/access-node --namespace <NAMESPACE> -f config/accessnode.yaml
243-
```
248+
11. Install the DOME Access Node
249+
```
250+
helm install access-node dome-access-node/access-node --namespace <NAMESPACE> -f config/accessnode.yaml
251+
```
244252
245-
NAMESPACE: The Kubernetes Cluster namespace where the DOME Access Node will be deployed.
253+
NAMESPACE: The Kubernetes Cluster namespace where the DOME Access Node will be deployed.
246254
247255
### How to configure
248256

doc/dome-key-generator-did-key.png

27.1 KB
Loading

doc/dome-key-generator-example.png

24 Bytes
Loading

doc/dome-key-generator-home.png

15.6 KB
Loading

0 commit comments

Comments
 (0)