trustchain-oc1-orchestral
/
devicehub-teal
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix READMES

This commit is contained in:
Cayo Puigdefabregas 2024-02-08 12:34:55 +01:00
parent 95700e7ba4
commit b6e9be306b
2 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -16,7 +16,7 @@ There is a Docker compose file for an automated deployment. The next steps descr
1. Download the sources: 1. Download the sources:
``` ```
git clone https://github.com/eReuse/devicehub-teal.git -b dpp git clone https://github.com/eReuse/devicehub-teal.git -b oidc4vp
cd devicehub-teal cd devicehub-teal
``` ```
@ -42,9 +42,19 @@ You can use these parameters as default for a local test, but default values may
API_DLT API_DLT
API_DLT_TOKEN API_DLT_TOKEN
API_RESOLVER API_RESOLVER
ABAC_TOKEN
ABAC_USER
ABAC_URL
``` ```
These values should come from an already operational [API_DLT connector](https://gitlab.com/dsg-upc/ereuse-dpp) service instance. These values should come from an already operational [API_DLT connector](https://gitlab.com/dsg-upc/ereuse-dpp) service instance.
If you want to use oidc4vp you need set the vars:
```
SERVER_ID_FEDERATED
CLIENT_ID_FEDERATED
```
You can see the [manual install step 9]('https://github.com/eReuse/devicehub-teal/blob/oidc4vp/README_MANUAL_INSTALLATION.md#installing') for get more detail.
4. Run the docker containers: 4. Run the docker containers:
``` ```
docker compose up docker compose up

16
README_MANUAL_INSTALLATION.md
View File

@ -16,7 +16,7 @@ The requirements are:
1. Generate a clone of the repository. 1. Generate a clone of the repository.
``` ```
git clone git@github.com:eReuse/devicehub-teal.git git clone git@github.com:eReuse/devicehub-teal.git -b oidc4vp
cd devicehub-teal cd devicehub-teal
``` ```
@ -24,8 +24,7 @@ The requirements are:
``` ```
python3.9 -m venv env python3.9 -m venv env
source env/bin/activate source env/bin/activate
pip3 install -U -r requirements.txt -e . sh examples/pip_install.sh
pip3 install Authlib==1.2.1
``` ```
3. Create a PostgreSQL database called *devicehub* by running [create-db](examples/create-db.sh): 3. Create a PostgreSQL database called *devicehub* by running [create-db](examples/create-db.sh):
@ -42,12 +41,12 @@ Configure project using environment file (you can use provided example as quicks
$ cp examples/env.example .env $ cp examples/env.example .env
``` ```
4. Running alembic from oidc module.y 4. Running alembic from oidc module.
``` ```
alembic -x inventory=dbtest upgrade head alembic -x inventory=dbtest upgrade head
``` ```
5. Running alembic from oidc module.y 5. Running alembic from oidc module.
``` ```
cd ereuse_devicehub/modules/oidc cd ereuse_devicehub/modules/oidc
alembic -x inventory=dbtest upgrade head alembic -x inventory=dbtest upgrade head
@ -87,13 +86,14 @@ $ cp examples/env.example .env
11. Register a new user in devicehub. 11. Register a new user in devicehub.
``` ```
flask adduser email@cxm.cxm password flask adduser email@example.org password
``` ```
12. Register a new user to the DLT. 12. Register a new user to the DLT.
``` ```
flask dlt_register_user email@cxm.cxm password Operator flask dlt_register_user examples/users_devicehub.json
``` ```
You need define your users in the file **users_devicehub.json**
13. Finally, run the app: 13. Finally, run the app:
@ -139,7 +139,7 @@ We want to interconnect two devicehub instances already installed. One has a set
For 20.1. This can be achieved on the terminal on the devicehub instance acting as OIDC identity server. For 20.1. This can be achieved on the terminal on the devicehub instance acting as OIDC identity server.
``` ```
flask adduser email@cxm.cxm password flask adduser email@example.org password
``` ```
* 20.2. This is an example of how to fill in the form. * 20.2. This is an example of how to fill in the form.