Skip to content

Commit d0896c2

Browse files
committed
refactor: renamed environment variables to match recent updates in https://github.com/crs4/cdpp-workflows
1 parent a383039 commit d0896c2

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/installation/02-setup.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,16 @@ To configure the Annotations Manager, edit the following variables in the `.env`
5151

5252
* `PROMORT_IMG`: Specifies the Docker image used for the Annotations Manager. You can browse available image versions on [Docker Hub](https://hub.docker.com/repository/docker/crs4/promort-web/general){:target="_blank"}.
5353
* `PROMORT_PORT`: Port used to access the Annotations Manager's web user interface
54-
* `PROMORT_DB`: Name of the database that will store the data for the Annotations Manager
55-
* `PROMORT_USER`: Username for connecting to `PROMORT_DB`
56-
* `PROMORT_PASSWORD`: Password for the `PROMORT_USER`
54+
* `PROMORT_DB_NAME`: Name of the database that will store the data for the Annotations Manager
55+
* `PROMORT_DB_USER`: Username for connecting to `PROMORT_DB`
56+
* `PROMORT_DB_PASSWORD`: Password for the `PROMORT_USER`
5757
* `PROMORT_SESSION_ID`: Session ID used for the Django session cookie
5858

59+
The system will automatically create a user in the Annotation Manager which will be used by the Workflow Engine's tools to interact with it when reading/writing data from/to is necessary. To setup this user edit the following variables:
60+
61+
* `PROMORT_USER`: Username of the user that will be used by the workflow engine's tools
62+
* `PROMORT_PASSWORD`: Password for the `PROMORT_USER` to access the Annotation Manager API
63+
5964
### Workflow Engine
6065

6166
To configure the Workflow Engine, edit the following variables in the `.env` file:
@@ -84,8 +89,8 @@ To configure the Workflow Engine, edit the following variables in the `.env` fil
8489
* `PROMORT_HOST`: Hostname of the Annotations Manager
8590
* `PROMORT_CONN_TYPE`: Protocol for connecting to the Annotations Manager
8691
* `PROMORT_PORT`: Port used by the Annotations Manager
87-
* `PROMORT_USER`: Username for the Annotations Manager database
88-
* `PROMORT_PASSWORD`: Password for the Annotations Manager database
92+
* `PROMORT_USER`: Username of the user to interact with the Annotations Manager
93+
* `PROMORT_PASSWORD`: Password for the `PROMORT_USER`
8994
* `PROMORT_SESSION_ID`: Session ID for the Django session cookie
9095
* `PROMORT_TOOLS_IMG`: Specifies the Docker image used for the Annotations Manager auxiliary tools. You can explore available versions on [Docker Hub](https://hub.docker.com/repository/docker/crs4/promort_tools/general){:target="_blank"}.
9196

0 commit comments

Comments
 (0)