Skip to content

Commit

Permalink
Han Kortekaas updated v1
Browse files Browse the repository at this point in the history
  • Loading branch information
exivity-bot committed Jul 25, 2024
1 parent ce24ec6 commit 9273238
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion proximity/v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -25004,7 +25004,7 @@
}
],
"id": "dcc7d52d-c5f5-35bd-a28b-182dbba9eec3",
"description": "#### Configuration Keys\n\nThe system can be configured using these endpoints.\n\n| **key** | **type** | **description** |\n| --- | --- | --- |\n| APP_DEBUG | _bool, default_ `false` | Turn debug mode on/off. In debug more, a lot more log files are generated. Not recommended for production systems. |\n| APP_NAME | _string, default_ `Exivity` | The name of the application |\n| APP_ICON | string, max length: 1024 kilobytes | Inline image, encoded in base64 |\n| APP_LOGO | string, max length: 512 kilobytes | Inline image, encoded in base64 |\n| APP_FAVICON | string, max length: 5 kilobytes | Website favicon. Inline image, encoded in base64 |\n| APP_COLOUR | _string, default_ `#00a8d8` | Brand colour |\n| APP_CSS | _string_ | Custom CSS to use on the website |\n| APP_DOCUMENTATION | _bool, default_ `true` | Enable to show documentation link in the website header. |\n| APP_LANGUAGE | _string, default_ `en` | |\n| FINGERPRINTER | _string, default_ `secure_ip_useragent` | Fingerprint algorithm used to verify user location matches location where token was generated. <br>**secure** - checks protocals match (e.g. http/https) <br>**ip** - Checks the IP addresses match. <br>**useragent** - Checks the request is coming from the same user agent. <br>Possible values: `secure_ip_useragent` / `secure_useragent` |\n| PUBLIC_ROOT | | The default front-end URL clients should connect to. Fill out as [https://example.com](https://example.com). |\n| SSO_LOGIN_METHOD | _in: local_user_or_ldap, local_user_only, local_user_or_saml, saml_only, local_user_or_ldap_or_saml**Default_ `local_user_or_ldap` | |\n| USE_LOCAL_STORAGE | | |\n| ANALYTICS | | |\n| ANALYTICS_EXTRA_PROPERTY | | |\n| ERROR_TRACKING | | Enabling this option will report anonymous error metrics so we can make our product better. |\n| BETA_FEATURES | | |\n| USE_CACHE | | |\n| CURRENCY | _string, default:_ `EUR` | |\n| CURRENCY_FORMAT | _string, default:_ `€` | |\n| DECIMAL_SEPARATOR | _string, default:_ `.` | |\n| CSV_DELIMITER | _in:_ `,`, `;`, `:`, `\\t`, pipe <br>_Default_: `,` | Field delimiter for CSV exports |\n| CSV_DECIMAL_SEPARATOR | _in:_ `,`, `.` <br>_Default:_ `.` | Decimal separator for CSV exports |\n| THOUSAND_SEPARATOR | _nullable, in:_ `,`, `.`, `'` or space <br>_Default:_ `,` | |\n| RATE_PRECISION | _int, default:_ `8` | Precision for rates as displayed on the summary report. |\n| REPORT_PRECISION | _int, default:_ `2` | Precision for currency amounts displayed on reports other than summaries. |\n| SUMMARY_PRECISION | _int, default:_ `2` | Precision for currency amounts displayed on the summary report. |\n| QUANTITY_PRECISION | _int, default:_ `6` | |\n| PERCENTAGE_PRECISION | _int, default:_ `2` | |\n| DATE_FORMAT | _string, default:_ `dd-MM-yyyy` | [https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table](https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table) |\n| SUMMARY_TITLE | _string, default_ `Summary` | |\n| SUMMARY_ADDRESS | | |\n| SUMMARY_IMAGE | | |\n| SUMMARY_EXTRA | | |\n| SUMMARY_MIN_COMMIT | _string, default_ `Uplift for minimum commitment of {quantity} {label}` | Used as line item description for minimum commit uplifts. The identifier `{quantity}` will be replaced with the minimum commitment quantity, and `{label}` will be replaced with the unit label. |\n| GRAPH_MAX_SERIES | _int, default_ `15` | |\n| REPORT_START_MONTH | _int, default_ `1` | |\n| DISCLAIMER_ENABLED | _bool, default_ `false` | Show disclaimer as a page overlay once to new users. Users will only be allowed to continue to the app if they agree with the disclaimer text. |\n| DISCLAIMER_TITLE | _string, default_ `Disclaimer` | Title shown in the disclaimer overlay. |\n| DISCLAIMER_TEXT | _string_ | Main disclaimer text shown in the disclaimer overlay. Markdown is supported. |\n| DISCLAIMER_AGREE_BUTTON_TEXT | _string, default_ `I agree` | Button text shown in the disclaimer overlay which users have to click in order to continue to the app. |\n| TOKEN_TTL | _string, default_ `4 hours` | Token lifetime - Set the token expiration time interval. Users will have to login again after their token expires. |\n| ALLOW_PERSISTENT_TOKENS | _bool, default_ `false` | Allow users to remain logged in for duration of the token lifetime. |\n| PASSWORD_POLICY | _in: length, length_dictionary, length_dictionary_entropy.**Default_ `length_dictionary` | `length` - min 8 characters long <br>`dictionary` - does not allow comon dictionary words. <br>`entropy` - the [Shannon Entropy](https://en.wikipedia.org/wiki/Entropy_(information_theory)) of the characters must be greater than 3.5 |\n| MAX_LOGIN_ATTEMPTS | _int, default_ `5` | |\n| LOGIN_ATTEMPTS_INTERVAL | _string_ | If null, there's no limit, otherwise, `15 minutes`, `1 hour`, `2 hours`, `30 minutes`, etc. |\n| BLOCK_LOGIN_DURATION | _string, default_ `15 minutes` | `15 minutes`, `1 hour`, `2 hours`, `30 minutes`, etc. |",
"description": "#### Configuration Keys\n\nThe system can be configured using these endpoints.\n\n| **key** | **type** | **description** |\n| --- | --- | --- |\n| APP_DEBUG | _bool, default_ `false` | Turn debug mode on/off. In debug more, a lot more log files are generated. Not recommended for production systems. |\n| APP_NAME | _string, default_ `Exivity` | The name of the application |\n| APP_ICON | string, max length: 1024 kilobytes | Inline image, encoded in base64 |\n| APP_LOGO | string, max length: 512 kilobytes | Inline image, encoded in base64 |\n| APP_FAVICON | string, max length: 5 kilobytes | Website favicon. Inline image, encoded in base64 |\n| APP_COLOUR | _string, default_ `#00a8d8` | Brand colour |\n| APP_CSS | _string_ | Custom CSS to use on the website |\n| APP_DOCUMENTATION | _bool, default_ `true` | Enable to show documentation link in the website header. |\n| APP_LANGUAGE | _string, default_ `en` | |\n| FINGERPRINTER | _string, default_ `secure_ip_useragent` | Fingerprint algorithm used to verify user location matches location where token was generated. <br>**secure** - checks protocals match (e.g. http/https) <br>**ip** - Checks the IP addresses match. <br>**useragent** - Checks the request is coming from the same user agent. <br>Possible values: `secure_ip_useragent` / `secure_useragent` |\n| PUBLIC_ROOT | | The default front-end URL clients should connect to. Fill out as [https://example.com](https://example.com). |\n| SSO_LOGIN_METHOD | _in: local_user_or_ldap, local_user_only, local_user_or_saml, saml_only, local_user_or_ldap_or_saml**Default_ `local_user_or_ldap` | |\n| USE_LOCAL_STORAGE | | |\n| ANALYTICS | | |\n| ANALYTICS_EXTRA_PROPERTY | | |\n| ERROR_TRACKING | | Enabling this option will report anonymous error metrics so we can make our product better. |\n| BETA_FEATURES | | |\n| USE_CACHE | | |\n| CURRENCY | _string, default:_ `EUR` | |\n| CURRENCY_FORMAT | _string, default:_ `€` | |\n| DECIMAL_SEPARATOR | _string, default:_ `.` | |\n| CSV_DELIMITER | _in:_ `,`, `;`, `:`, `\\t`, pipe <br>_Default_: `,` | Field delimiter for CSV exports |\n| CSV_DECIMAL_SEPARATOR | _in:_ `,`, `.` <br>_Default:_ `.` | Decimal separator for CSV exports |\n| THOUSAND_SEPARATOR | _nullable, in:_ `,`, `.`, `'` or space <br>_Default:_ `,` | |\n| RATE_PRECISION | _int, default:_ `8` | Precision for rates as displayed on the summary report. |\n| REPORT_PRECISION | _int, default:_ `2` | Precision for currency amounts displayed on reports other than summaries. |\n| SUMMARY_PRECISION | _int, default:_ `2` | Precision for currency amounts displayed on the summary report. |\n| QUANTITY_PRECISION | _int, default:_ `6` | |\n| PERCENTAGE_PRECISION | _int, default:_ `2` | |\n| DATE_FORMAT | _string, default:_ `dd-MM-yyyy` | [https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table](https://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table) |\n| SUMMARY_TITLE | _string, default_ `Summary` | |\n| SUMMARY_ADDRESS | | |\n| SUMMARY_IMAGE | | |\n| SUMMARY_EXTRA | | |\n| SUMMARY_MIN_COMMIT | _string, default_ `Uplift for minimum commitment of {quantity} {label}` | Used as line item description for minimum commit uplifts. The identifier `{quantity}` will be replaced with the minimum commitment quantity, and `{label}` will be replaced with the unit label. |\n| GRAPH_MAX_SERIES | _int, default_ `15` | |\n| REPORT_START_MONTH | _int, default_ `1` | |\n| DISCLAIMER_ENABLED | _bool, default_ `false` | Show disclaimer as a page overlay once to new users. Users will only be allowed to continue to the app if they agree with the disclaimer text. |\n| DISCLAIMER_TITLE | _string, default_ `Disclaimer` | Title shown in the disclaimer overlay. |\n| DISCLAIMER_TEXT | _string_ | Main disclaimer text shown in the disclaimer overlay. Markdown is supported. |\n| DISCLAIMER_AGREE_BUTTON_TEXT | _string, default_ `I agree` | Button text shown in the disclaimer overlay which users have to click in order to continue to the app. |\n| TOKEN_TTL | _string, default_ `4 hours` | Token lifetime - Set the token expiration time interval. Users will have to login again after their token expires. |\n| ALLOW_PERSISTENT_TOKENS | _bool, default_ `false` | Allow users to remain logged in for duration of the token lifetime. |\n| PASSWORD_POLICY | _in: length, length_dictionary, length_dictionary_entropy.**Default_ `length_dictionary` | `length` - see PASSWORD_MIN_LENGTH <br>`dictionary` - does not allow comon dictionary words. <br>`entropy` - the [Shannon Entropy](https://en.wikipedia.org/wiki/Entropy_(information_theory)) of the characters must be greater than 3.5 |\n| PASSWORD_MIN_LENGTH | _int, default_ `_8_` (min: `8`, max: `60`) | Set the minimum length of the passwords used. Defaults to 8. |\n| MAX_LOGIN_ATTEMPTS | _int, default_ `5` | |\n| LOGIN_ATTEMPTS_INTERVAL | _string_ | If null, there's no limit, otherwise, `15 minutes`, `1 hour`, `2 hours`, `30 minutes`, etc. |\n| BLOCK_LOGIN_DURATION | _string, default_ `15 minutes` | `15 minutes`, `1 hour`, `2 hours`, `30 minutes`, etc. |",
"auth": {
"type": "noauth"
},
Expand Down

0 comments on commit 9273238

Please sign in to comment.