Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add configuration parameters section to README.md #79

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Add configuration parameters section to README.md #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72dc34c
Add configuration parameters section to README.md
blcham Nov 6, 2024
e01f4da
Update README.md
blcham Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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).

-----
Expand Down
Loading