From b6e9be306b428dee1a0620160305cdebc16c8bd5 Mon Sep 17 00:00:00 2001 From: Cayo Puigdefabregas Date: Thu, 8 Feb 2024 12:34:55 +0100 Subject: [PATCH] fix READMES --- README.md | 12 +++++++++++- README_MANUAL_INSTALLATION.md | 16 ++++++++-------- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index bfb85799..e306bb70 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ There is a Docker compose file for an automated deployment. The next steps descr 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 ``` @@ -42,9 +42,19 @@ You can use these parameters as default for a local test, but default values may API_DLT API_DLT_TOKEN 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. +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: ``` docker compose up diff --git a/README_MANUAL_INSTALLATION.md b/README_MANUAL_INSTALLATION.md index 4e889dc1..da8a69f7 100644 --- a/README_MANUAL_INSTALLATION.md +++ b/README_MANUAL_INSTALLATION.md @@ -16,7 +16,7 @@ The requirements are: 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 ``` @@ -24,8 +24,7 @@ The requirements are: ``` python3.9 -m venv env source env/bin/activate - pip3 install -U -r requirements.txt -e . - pip3 install Authlib==1.2.1 + sh examples/pip_install.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 ``` -4. Running alembic from oidc module.y +4. Running alembic from oidc module. ``` alembic -x inventory=dbtest upgrade head ``` -5. Running alembic from oidc module.y +5. Running alembic from oidc module. ``` cd ereuse_devicehub/modules/oidc alembic -x inventory=dbtest upgrade head @@ -87,13 +86,14 @@ $ cp examples/env.example .env 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. ``` - 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: @@ -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. ``` - 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.