Cian-H/I-Form_Server_Node_Deployer
1
0
Fork 0
mirror of https://github.com/Cian-H/I-Form_Server_Node_Deployer.git synced 2025-12-27 08:32:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Quick, rough draft of docs

Browse Source
This commit is contained in:
Cian Hughes
2023-11-06 16:27:35 +00:00
parent a01b89e47d
commit a42bc728f6
7 changed files with 147 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/configuration.md Normal file
View File

@@ -0,0 +1,59 @@
# Configurations
The following is a list of preprogrammed configurations for the node deployer.
## default
This is the default configuration on which all other configurations are based.
| Variable | Value | Type |
| --- | --- | --- |
| SRC_DIR | "src" | Path |
| BUILD_DIR | "build" | Path |
| DOCKERFILE_DIR | "docker" | Path |
| SELENIUM_INIT_MESSAGE | "INFO [Standalone.execute] - Started Selenium Standalone" | str |
| FUELIGNITION_INIT_MESSAGE | "ready in *ms." | str |
| FUELIGNITION_URL | "http://localhost:3000/fuel-ignition/edit" | str |
| FUELIGNITION_BUILD_DIR | "fuel-ignition" | Path |
| CWD_MOUNTDIR | "/host_cwd" | Path |
| CLIENT_STDOUT | True | bool |
| CLEANUP_IMAGES | True | bool |
| CLI | False | bool |
| DEBUG | False | bool |
| TESTING | False | bool |
## local
This configuration keeps all computations local to the machine on which the tool is run.
| Variable | Value | Type |
| --- | --- | --- |
| FUELIGNITION_URL | "http://localhost:3000/fuel-ignition/edit" | str |
## remote
<p>This configuration allows the use of hosted websites for hte fuel-ignition configurator.</p>
<p>Currently, this configuration is broken/deprecated. It is being kept as it may be be reimplemented in the future as part of a dockerless configuration.</p>
| Variable | Value | Type |
| --- | --- | --- |
| FUELIGNITION_URL | "https://opensuse.github.io/fuel-ignition/edit" | str |
## cli
This configuration enables a typer based command line interface.
| Variable | Value | Type |
| --- | --- | --- |
| CLI | True | bool |
## debug
This configuration enables debug mode.
| Variable | Value | Type |
| --- | --- | --- |
| DEBUG | True | bool |
| CLI | False | bool |
| CLEANUP_IMAGES | False | bool |
## test
This configuration enables testing mode. This mode is used for testing the tool itself.
| Variable | Value | Type |
| --- | --- | --- |
| TESTING | True | bool |
| CLEANUP_IMAGES | False | bool |