diff --git a/README.md b/README.md index 95cf28e2..34db1255 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,7 @@ The configuration file should contain the following config keys: "launcherVersion": "", // string (default: null) "logFolder": "", // string (default: "/logs") "logLevel": "", // string (default: "Information") + "packageCache": "", // string (default: "/cache") "packagesUrl": "", // string (default: "https://packages-2-0[-sandbox].fiskaltrust.cloud") "helipadUrl": "", // string (default: "https://helipad[-sandbox].fiskaltrust.cloud") "downloadRetry": "", // int (default: 1) @@ -109,7 +110,7 @@ The configuration file should contain the following config keys: "configurationUrl": "", // string (default: "https://configuration[-sandbox].fiskaltrust.cloud") "downloadTimeoutSec": "", // int (default: 15) "processHostPingPeriodSec": "", // int (default: 10) - "cashboxConfigurationFile": "", // string (default: "configuration-.json") + "cashboxConfigurationFile": "", // string (default: "/service/Configuration-.json") "useHttpSysBinding": "useHttpSysBinding", // bool (default: false) } ``` @@ -122,35 +123,35 @@ All of these config keys can be overridden using the corresponding cli arguments The _**run**_ command of the fiskaltrust. Launcher tool is used to execute the launcher, providing users with various options to configure its behaviour and logging details. -| Option | Description | -|---------------------------------------------------------------|-----------------------------------------------------------------------------------| -| `--cashbox-id ` | Specifies the ID of the cashbox. | -| `--access-token ` | Token used for authentication. | -| `--sandbox` | Enables sandbox mode. | -| `--log-folder ` | Path to the folder where logs will be saved. | -| `--log-level ` | Determines the logging level. Accepts values like Critical, Debug, etc. | -| `--launcher-configuration-file ` | Path to the launcher configuration file. Defaults to launcher.configuration.json. | -| `--legacy-configuration-file ` | Path to the legacy configuration file. Defaults to fiskaltrust.exe.config. | -| `--merge-legacy-config-if-exists` | If set, merges legacy configuration if it exists. Default is true. | -| `--launcher-port ` | Specifies the port which the launcher will use for internal communication. | -| `--use-offline` | Enables offline mode. | -| `--service-folder ` | Path to the service folder. | -| `--configuration-url ` | URL for the configuration. | -| `--packages-url ` | URL to fetch packages from. | -| `--package-cache ` | Cache directory for the packages. | -| `--helipad-url ` | URL for the helipad. | -| `--download-timeout-sec ` | Timeout for downloads in seconds. | -| `--download-retry ` | Number of times to retry a failed download. | -| `--ssl-validation` | Validates SSL certificates. | -| `--proxy ` | Proxy server details. | -| `--processhost-ping-period-sec ` | Ping period for the process host in seconds. | -| `--cashbox-configuration-file ` | Path to the cashbox configuration file. | -| `--tls-certificate-path ` | Path to the TLS certificate. | -| `--tls-certificate-base64 ` | Base64 encoded TLS certificate. | -| `--tls-certificate-password ` | Password for the TLS certificate. | -| `--use-http-sys-binding ` | Uses HTTP sys binding. | -| `--use-legacy-data-protection ` | Enables use of legacy data protection. | -| `-?` , `-h` , `--help` | Displays help and usage information. | +| Option | Description | Default | +|---------------------------------------------------------------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| `--cashbox-id ` | Specifies the ID of the cashbox. | | +| `--access-token ` | Token used for authentication. | | +| `--sandbox` | Enables sandbox mode. | `false` | +| `--log-folder ` | Path to the folder where logs will be saved. | `"/logs"` | +| `--log-level ` | Determines the logging level. Accepts values like Critical, Debug, etc. | `"Information"` | +| `--launcher-configuration-file ` | Path to the launcher configuration file. | `"launcher.configuration.json"` | +| `--legacy-configuration-file ` | Path to the legacy configuration file. | `"fiskaltrust.exe.config"` | +| `--merge-legacy-config-if-exists` | If set, merges legacy configuration if it exists. | `true` | +| `--launcher-port ` | Specifies the port which the launcher will use for internal communication. | `5050` | +| `--use-offline` | Enables offline mode. | `false` | +| `--service-folder ` | Path to the service folder. | windows: `"C:/ProgramData/fiskaltrust"`
linux: `"/var/lib/fiskaltrust"`
macos: `"/Library/Application Support/fiskaltrust"` | +| `--configuration-url ` | URL to fetch the configuration from. | `"https://configuration[-sandbox].fiskaltrust.cloud"` | +| `--packages-url ` | URL to fetch packages from. | `"https://packages-2-0[-sandbox].fiskaltrust.cloud"` | +| `--package-cache ` | Cache directory for the packages. | `"/cache"` | +| `--helipad-url ` | URL for the helipad. | `"https://helipad[-sandbox].fiskaltrust.cloud"` | +| `--download-timeout-sec ` | Timeout for downloads in seconds. | `15` | +| `--download-retry ` | Number of times to retry a failed download. | `1` | +| `--ssl-validation` | Validates SSL certificates. | `true` | +| `--proxy ` | Proxy server details. | | +| `--processhost-ping-period-sec ` | Ping period for the process host in seconds. | `10` | +| `--cashbox-configuration-file ` | Path to the cashbox configuration file. | `""/service/Configuration-.json"` | +| `--tls-certificate-path ` | Path to the TLS certificate. | | +| `--tls-certificate-base64 ` | Base64 encoded TLS certificate. | | +| `--tls-certificate-password ` | Password for the TLS certificate. | | +| `--use-http-sys-binding ` | Uses HTTP sys binding. | `false` | +| `--use-legacy-data-protection ` | Enables use of legacy data protection. | `false` | +| `-?` , `-h` , `--help` | Displays help and usage information. | | ## `config`