-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a501ebf
commit 47b728c
Showing
18 changed files
with
153 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,25 @@ | ||
--- | ||
title: 🧩 Flows | ||
order: 10 | ||
title: Flows | ||
order: 30 | ||
--- | ||
|
||
# Issuance and Verification Flows | ||
|
||
|
||
# Parameters | ||
Flows define the full behaviour of credential issuance and verification. While the Template define the Flow's core business logic, you define in the Flow parameters such as the duration of a credential, the cryptography and protocols to be used, the Microservices it should run on, as well as the data that is visible by the user (name, description, logo) as well as the machine-readable data used in the communication protocols (e.g. OpenID4VCI and OpenID4VP). | ||
|
||
- **TLDR: what is actually Flow in DIDroom?** | ||
> [!NOTE] | ||
> Imagine a Flow as a shell of extra parameters that surround a template. Imagine that you are offering the same credentials, once with a 1 day expiration and once with a 1 month expiration: the templates used will typically be the same, while the Flow configurations will change. | ||
# Provivionins and Microservices | ||
|
||
## Parameters | ||
|
||
# Flows | ||
When editing the a Flow, you're editing several parameters, some of them are machine-readable, some are human readable, some have impact on the credentials that will be issued (*Cryptography* type and *Expiration*), some impact the deployment (the *Microservices* section). | ||
|
||
| Dashboard Flow Editor | | ||
|--| | ||
| <img src="../images/dashboard/flow-editor.png" alt="dashboard-flow-editor" width="1000"/> | | ||
|
||
# Toolchain | ||
|
||
|
||
# Extendability | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,66 @@ | ||
--- | ||
title: 🧩 Microservices | ||
order: 30 | ||
title: Microservices | ||
order: 40 | ||
--- | ||
|
||
# Basics | ||
Credential Issuance and Verification are (partly) executed in Microservices. The Microservices are configured in the Dashboard, the Dashboard also provides you with the actuall Microservices code, with different deployment possibilities. | ||
|
||
|
||
# Configuration | ||
## Configuration | ||
|
||
You can create a new Microservice or edit it, by giving it a *Name* and an *Endpoint*, the *Port* is initially selected randomly but can be edited. | ||
|
||
# Protocols (OID4VCI & more) | ||
| Microservices setup | | ||
|--| | ||
| <img src="../images/dashboard/microservices-setup.png" alt="microservices-setup" width="1000"/> | | ||
|
||
## Deployment | ||
|
||
# Parameters and presets | ||
Once you are happy with the Templated and Flows you created, you can start deploying them. You that by: | ||
|
||
1. Downloading the provisioned Microservices by pressing the *Dowload microservices* button. | ||
1. Upload the download .zip to the server where the Microservices will deployed, which responds to the Endpoint you previously configured. | ||
1. Use the docker-compose file (typically doing | ||
|
||
# Toolchain | ||
```bash | ||
docker-compose up | ||
``` | ||
|
||
---- | ||
|
||
# Extendability | ||
See below the *Home > Organization > Microservices* page: | ||
|
||
|
||
| Microservices list and Deployment | | ||
|--| | ||
| <img src="../images/dashboard/microservices-manual-deployment-small.png" alt="microservices-manual-deployment-small" width="1000"/> | | ||
|
||
|
||
|
||
## Extendability | ||
|
||
DIDroom Microservices are implemented and deployed using: | ||
|
||
|
||
- NCR (no-code room): REST API server for Zencode scripts, single binary, doesn't require su privildges, includes OpenAPI and automagic GUI for REST APIs see | ||
|
||
-> Repo: https://github.com/ForkbombEu/ncr | ||
|
||
- DIDroom Microservices: OpenID4VCI and OpenID4VP compatible Microservices, highly customizable, implemented in Zencode (with some JS). This is where the server-side of new protocols and new cryptography is implemented. | ||
|
||
-> Repo: https://github.com/ForkbombEu/DIDroom_microservices | ||
|
||
- Ghisa: minimalist 0-security proxy, saves you from (some) CORS errors. | ||
|
||
-> Repo: https://github.com/ForkbombEu/ghisa | ||
|
||
|
||
- Zenroom: Cryptographic virtual machine, powers all (almost) the cryptogrphy in DIDroom. Ultra portable, runs on server/mobile/browser/IoT. | ||
|
||
-> Repo: https://dev.zenroom.org/ | ||
|
||
- Slangroom: Extension to Zenroom, for networking, database, file management. See: | ||
|
||
-> Repo: https://dyne.org/slangroom/ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+159 KB
docs/guides/images/dashboard/microservices-manual-deployment-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.