[#80] Add configuration parameters section to README.md

kbss-cvut · Nov 6, 2024 · 68dba1f · 68dba1f
1 parent 41eb02c
commit 68dba1f
Showing 1 changed file with 16 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# OFN Record Manager
+# Record Manager
 
-Manager of records based on OFN (https://data.gov.cz/ofn/).
+Record Manager is an application for generic form-based collection of data. This repository contains the backend of the application.
 
 ## Required Technologies
 
@@ -9,11 +9,23 @@ Manager of records based on OFN (https://data.gov.cz/ofn/).
 
 ## System Architecture
 
-The system can be split into two parts. __Main application__ provides management of users, organizations and their records. The system manages multiple types of records which are generated dynamically by __Form service__ defined in https://github.com/opendata-mvcr/sgov-forms .  
+The system can be split into two parts. __Main application__ provides management of users, organizations and their records. The system manages multiple types of records which are generated dynamically by __Form service__.  
+
+## Configuration
+
+### Further Record Manager Configuration
+
+The following table lists the names of environment variables that can be
+passed to Record Manager backend either directly in `docker-compose.yml`, in
+an [env_file](https://docs.docker.com/compose/compose-file/compose-file-v3/#env_file), or via command line.
+
+| Variable                                           | Explanation                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+|:---------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ```RECORDS_ALLOWEDREJECTREASON```\               | Allow user to enter reason when rejecting records. Default value: `false.`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 
 ## Documentation
 
-Build configuration and deployment is described in [Setup Guide](doc/setup.md).
+Build configuration and deployment are described in [Setup Guide](doc/setup.md).
 Development is described in [Development notes](doc/development.md).
 
 -----