From 55974242a6c058746443b009aaa4a8d5d153a2af Mon Sep 17 00:00:00 2001 From: Gerwoud Van den Eynden <62761483+Gerwoud@users.noreply.github.com> Date: Mon, 20 May 2024 16:14:36 +0200 Subject: [PATCH] Update backend README (#357) * added table to frontend readme * added .env vars to the README * added readme vars * changes * added explanation * removed changes to frontend readme to exclude it from this pr * remove code verifier * added JWT application * POST_HOST name * added rfc link * added microsoft admin link * updated link --- backend/README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/backend/README.md b/backend/README.md index b7cd5ee4..d9f0dc48 100644 --- a/backend/README.md +++ b/backend/README.md @@ -27,14 +27,18 @@ the regular base application. The project requires a couple of environment variables to run, if you want to develop on this codebase. Setting values for these variables can be done with a method to your own liking. -| Variable | Description | -|-------------------|----------------------------------------------------------------| -| DB_HOST | Url of where the database is located | -| POSTGRES_USER | Name of the user, needed to login to the postgres database | -| POSTGRES_PASSWORD | Password of the user, needed to login to the postgres database | -| POSTGRES_HOST | IP adress of the postgres database | -| POSTGRES_DB | Name of the postgres database | -| API_HOST | Location of the API root | +| Variable | Description | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| POSTGRES_USER | Name of the user, needed to login to the postgres database | +| POSTGRES_PASSWORD | Password of the user, needed to login to the postgres database | +| POSTGRES_HOST | Location of the postgres database | +| POSTGRES_DB | Name of the postgres database | +| API_HOST | Location of the API root | +| CLIENT_ID | [Client id](https://learn.microsoft.com/nl-nl/entra/identity-platform/v2-protocols) | +| CLIENT_SECRET | Client's secret is your personal secret key for authentication, this can be found at the [Entra ID admin center](https://learn.microsoft.com/en-us/purview/sit-defn-azure-ad-client-secret) | +| JWT_SECRET_KEY | JWT secret key is the key used to encode the JWT's and should be kept secret, because otherwise everyone can create "valid" JWT's for our application. Variable should be a random 32 characters long string, if you need more information please refer to the [RDF documentation](https://www.rfc-editor.org/rfc/rfc4868#page-3) | +| TENANT_ID | [Tenant id](https://learn.microsoft.com/nl-nl/entra/fundamentals/whatis), an ID that is used to identify yourself to the microsoft servic | +| HOMEPAGE_URL | URL of where the website's homepage is located | All the variables except the last one are for the database setup, these are needed to make a connection with the database.