Explain the environment variables

acdh-oeaw · Oct 6, 2023 · f150ccb · f150ccb
1 parent 38a6edc
commit f150ccb
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,4 +14,14 @@ openapi-python-generator --library aiohttp dboeannotation_openapi3_0.json dboean
 # and
 yq -o=json '.' vleserver_openapi3_0.yaml > vleserver_openapi3_0.json
 openapi-python-generator --library aiohttp vleserver_openapi3_0.json vleserver
-```
+```
+
+This code uses the following environment variables
+
+| Variable                    | Description                                      | default                                                   |
+|-----------------------------|--------------------------------------------------|-----------------------------------------------------------|
+| DBOEANNOTATION_HOST         | DBOE Annotation host that has data in its cache  | https://dboeannotation-test.acdh-dev.oeaw.ac.at           |
+| DBOEANNOTATION_USER         | User for this DBOE Annotation host               | vle                                                       |
+| DBOEANNOTATION_PASSWORD     | Password for this DBOE Annotation host           | changeme_please                                           |
+| VLESERVER_HOST              | The XML database host the data should be sent to | http://localhost:8984                                     |
+| VLESERVER_BASIC_AUTH_BASE64 | The already Base64 encoded string after `Basic`  | The equivalent of admin:sha256(admin), needs to be set up |