-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Configuration fields described in documentation
- Loading branch information
Vítězslav Dvořák
committed
Dec 17, 2024
1 parent
efc2060
commit 9df8e85
Showing
2 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. _configuration: | ||
|
||
Configuration | ||
============= | ||
|
||
Each application in MultiFlexi defines its own configuration fields. This is of a specific type and has additional properties. | ||
|
||
Configuration Fields | ||
-------------------- | ||
|
||
- Configuration Field Type - one of the following: | ||
- **Text**: A single line text input. | ||
- **Number**: A numeric input. | ||
- **Date**: A date input. | ||
- **Email**: An email input. | ||
- **Password**: A password input. | ||
- **Checkbox**: A yes/no checkbox. | ||
- **File**: A file upload input. | ||
- **Directory**: A directory path input. | ||
- Keyword - (capital letters) | ||
- Default Value - (used unless otherwise specified) | ||
- Configuration Field Description | ||
- required yes/no | ||
|
||
.. image:: appconfigfieldseditor.png | ||
:alt: Configuration fields of an application in an editor | ||
|
||
|
||
JSON Configuration | ||
----- | ||
|
||
To configure the MultiFlexi project, you can also create a configuration file (e.g., `config.yaml`) with the necessary fields. Below is an example configuration file: | ||
|