You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation/02-setup.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,11 +51,16 @@ To configure the Annotations Manager, edit the following variables in the `.env`
51
51
52
52
*`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"}.
53
53
*`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`
57
57
*`PROMORT_SESSION_ID`: Session ID used for the Django session cookie
58
58
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
+
59
64
### Workflow Engine
60
65
61
66
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
84
89
*`PROMORT_HOST`: Hostname of the Annotations Manager
85
90
*`PROMORT_CONN_TYPE`: Protocol for connecting to the Annotations Manager
86
91
*`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`
89
94
*`PROMORT_SESSION_ID`: Session ID for the Django session cookie
90
95
*`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"}.
0 commit comments