mirror of
https://github.com/interfacerproject/zenflows-fabaccess.git
synced 2025-03-12 06:51:43 +01:00
docs: README
This commit is contained in:
parent
dd265d4e7c
commit
8eb9e416ca
29
README.md
Normal file
29
README.md
Normal file
@ -0,0 +1,29 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Dyne.org foundation
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# 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/`.
|
Loading…
x
Reference in New Issue
Block a user