diff --git a/README.md b/README.md new file mode 100644 index 0000000..b75a61a --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ + + +# zenflows-fabaccess + +Interface between [interfacer-gui](https://github.com/interfacerproject/interfacer-gui) and +[FabAccess BFFH](https://gitlab.com/fabinfra/fabaccess/bffh) using the +[python bindings](https://gitlab.com/fabinfra/fabaccess/pyfabapi) that verify the extistence +of a DID for the user using [did.dyne.org](explorer.did.dyne.org). + +## Configuration + +The configuration is done by providing environment variables. + +Here is the list of them: + +* `FAB_HOST` - hostname MQTT server +* `FAB_PORT` - port of MQTT server +* `FAB_USER` - valid username for bffh +* `FAB_USER` - valid password for bffh +* `DID_URL` - url for the DID controller +* `DELTA_TIMESTAMP` - how long is a request valid (in seconds) + +## Examples + +See the subdirectory `example/`.