Frigg and braga use a configuration file (config.ini) with which is loaded at startup.
...
| key | example | description | frigg | braga |
|---|---|---|---|---|
| database_host | 192.168.5.57 | the database host (IP or hostname) | X | X |
| database_jndi | java:comp/env/jdbc/FriggDb | the jndi database source | X | X |
| database_master | frigg_master | Name of the master database, which manages sequences and tenants in multitenant mode. Default: frigg_master | X | X |
| database_migrate | true/false | true or false. If true, flyway database management is activated | X | |
| database_name | frigg | the database schema name | X | X |
| database_password | kjssdduiwe832//6?! | the database password | X | X |
database_port | 1521 | the database port | X | X |
database_service_name | FRIGG | the database service name (for Oracle connection) | X | X |
database_sid | xe | the database SID (for Oracle connection) | X | X |
| database_type | mysql | mysql or oracle, the database type (default mysql) | X | X |
| database_user | dbuser | the database user | X | X |
| db_pool_max_wait_millis | soll hinzugefügt werden? | specifies the maximum time in milliseconds that the connection pool should wait for a connection to be returned before throwing an exception. The default value is 5000. | X | X |
| db_pool_max_total | soll hinzugefügt werden? | specifies the maximum number of connections that the database pool can have simultaneously open. The default is 100. | X | X |
| db_pool_max_idle | soll hinzugefügt werden? | specifies the maximum number of idle database connections to be maintained in the pool at any given time. The default value is 20. | X | X |
| db_pool_min_idle | soll hinzugefügt werden? | specifies the minimum number of idle connections that should be maintained in the connection pool. This property is used to ensure that a sufficient number of connections are available in the pool at all times. Default is 5. | X | X |
| db_pool_max_conn_lifetime_millis | soll hinzugefügt werden? | specifies the maximum lifetime of a database connection in the connection pool. Default is 60000. | X | X |
| deactivate_db_ping | true | true or false, deactivates validation check for the db connection (default false) | X | X |
| storage_db_init_directory |
...
| key | example | description | frigg | braga |
|---|---|---|---|---|
extra_password_prompt | 0 | activates an extra password prompt in the iSignatureOffice / aSignatureOffice app (authentication with fingerprint or face ID). 0 = deactivated, 1 = activated (default 0) | X | |
| password_interval | ALWAYS | If extra_password_prompt is activated, you can use password_interval to specify how often the query should appear. Possible values: ALWAYS, DAILY
| X |
Viewer settings
The following settings customize the viewer.
| key | example | description | frigg | braga |
|---|---|---|---|---|
| accept_terms_settings | true | true or false, if terms and conditions have to be accepted before signing as a guest / in standalone viewer | X | |
| activate_stepover_footer | false | true or false, activates the footer in the standalone viewer with terms of use, imprint and data protection (StepOver information). Default is false | X | |
| always_mobile_viewer_on_mobile_device | true | true or false, determines whether on mobile devices can be signed exclusively with the HTML Signer (no matter if 'desktop browser' is set or not) | X | |
| api_id_mode | obfuscated | Defines how ID values like the document_id are displayed encrypted. Possible values are: "obfuscated" = IDs are displayed encrypted (this is the config default value, if no other value is set) "debug" = IDs are displayed encrypted and the corresponding (original) ID is appended at the beginning of the value | X | |
| automatic_role_stop | false | Indicates whether the automatic role stop is executed or not. Automatic role stop means that after signing all fields of a signature group (<SignatureGroup> definition), the signature selection window for the next signature group is displayed again (if automatic_role_stop is true) | X | |
| conditions_exception | selection_pad;selection_display | specifies if a download condition must be fullfilled for a given signature type. The download pop-up won't be shown, if the signature type matches the value. Possible values: selection_display, selection_pad, selection_capture | X | |
| context_sign_mode | true | true or false. When active it's necessary to click in the signature field after clicking "sign now".
Default true. | X | |
| custom_text_selection_window | Bitte vorab alle notwendigen Kundeninformationen übermitteln | If the value is set, it will be displayed in the signature type popup (under the selection options) (formerly show_custom_text) please note: This text is the same for every viewer language. It's only advisable to use, if only one language is used.
| ||
| deactivate_document_download | false | true or false, deactivates the download button on the viewer (for finished or failed requests) (default false) | X | |
| deactivate_final_status_popup | true | true or false, deactivates the final status popup shown after all fields have been signed (default true)
| X | |
| deactivate_geolocation | false | true or false, deactivates the geolocation query in the browser (default false) | X | |
| deactivate_optional_fields_popup | false | true or false, deactivates the appearance of the popup after skipping the last optional field of a signature request which asks for ignoring the field (sign later) or finishing the request (only if there are no mandatory fields!) (default false) if true also the "finish signature process" button (shown after signing all mandatory fields) is deactivated.
If it is set to true, also the "skip" button of the last optional field isn't shown.
| X | |
| deactivate_reject_button | mandatory | "true", "false", "optional", "mandatory", defines when the "reject" button is active during signing. (default false) true: reject button is never active false: reject button is alsways active mandatory: reject button is inactive for mandatory signature fields optional: reject button is inactive for optionals signature fields | X | |
| deactivate_reject_reason_popup | true | deactivates the overlay to enter a reason when declining a signature (default false):
true: reason popup is deactivated false: reject button is alsways active mandatory: reason popup is inactive for mandatory signature fields optional: reason popup is inactive for optionals signature fields | X | |
deactivate_reject_reason_popup_reason | true | deactives the reason textfield in the reject reason popup. Only a warning will be shown. (see above) true: reason textfield is deactivated false: reason textfield is alsways active mandatory: reason textfield is inactive for mandatory signature fields optional: reason textfield is inactive for optionals signature fields | X | |
deactivate_remember_sign_type | true | deactivates the "remember sign type" checkbox of the signature type selection popup (default false) | X | |
| deactivate_skip_button | true | true or false, if true, the "skip" button is not shown for (optional) signature fields (default false) | X | |
formfields_writable_for_others | false | true or false, allows other signers to edit formfields | X | |
| html_signer_signature_field_width | 10 | defines the signature field width for signing with html-signer in cm, default is 14cm. | X | |
| link_close_button | https://www.yourcompany.com/Close.html | URL redirect of the "close" button. If not present, the button redirects to the websignatureoffice Desktop page. | X | |
| link_finished_button | https://www.yourcompany.com/ThankYou.html | URL redirect of the "finished" button. If not present, the button redirects to the websignatureoffice Desktop page. | X | |
| link_error_page_home_button | https://www.yourcompany.com/Error.html | URL redirect of the "home" button on the error page. If not present, the button redirects to the websignatureoffice Desktop page. | ||
| deprecated
| X | ||
| secondary_translations_url | URL pointing to a file to override the GUI and viewer translations. See Secondary Translations for details. | X | ||
| signature_field_pencil_cursor | true/false | If true, the mouse coursor is a pencil in html viewer signature fields. | X | |
deprecated | X | |||
| show_finish_pad_signature_button_in_browser | true | true or false, if set to "true", the "accept_signature"-button will be shown in the browser while signing with a signature-pad Default true. | X | |
| show_pages_preview | 1 | handles the page preview display in the document viewer (in apps and browser) 0 = deactivated, 1 = activated | X | |
show_selection_capture | true | activates/deactivates the "SMARTPHONE/TABLET" option of the signature type selection popup (default = true) | X | |
show_selection_display | true | activates/deactivates the "ON THIS DISPLAY" option of the signature type selection popup (default = true) | X | |
| show_selection_link | deprecated | |||
| activates/deactivates the "SIGNATURE PAD" option of the signature type selection popup (default = true) | X | ||
| show_toc | 1 | handles the table of contents display in the document viewer (in apps and browser) 0 = deactivated, 1 = activated | X | |
| viewer_sidebar_position | "left" | "left" or "right", defines if the viewer-sidebar (document preview and toc) is on the left or right site of the document. default "left" | X |
Signature Pad
| key | example | description | frigg | braga |
|---|---|---|---|---|
| activate_hash_dialog | true | true or false, activates the hash dialog during signing with StepOver Pads. The hash must be confirmed after every signature. viewer:
pad:
| X | |
| padcon_multi_user | true/false | true or false: Activates the multi user support for citrix workstations. Default false | X | |
| pad_connector_crypto_id_names | StepOver Bio 2048/4096;StepOver 2048/4096;StepOver cryptoIdv2 | semicolon seperated list of allowed notary key names to use when signing with a pad. The pad contains one or more keys for encrypting the bio data. The keys are identified by “crypto id names” and a “crypto id”, which are obtained from websignatureOffice via the pad connector (getDeviceDetails). If the config pad_connector_crypto_id_names is not set, the signature will be encrypted with the standard key of the pad. If the config pad_connector_crypto_id_names is set, webso retrieves the crypto id infos from the pad, which contain the name and crypto id and names of the keys. It then iterates over both lists and searches for a crypto id name which is in both lists. If a matching crypto id name is found, the singing is started with the crypto id of the first matching key. If no matching crypto id name is found and crypto_id_abort_message is defined, the process is aborted and the message shown. If no matching crypto id name is found and crypto_id_abort_message is not set, the signing will be started without a crypto id and the default key of the pad is used. for more information see Notary Key | X | |
| pad_connector_crypto_id_abort_message | no suitable key found on the pad, sorry | the text to be shown if no suitable pad connector can be found for more information see Notary Key | X | |
| deprecated | ||||
| pad_document_viewing | true | true or false, automatic connection to the signature pad is started when opening time limited viewers (no matter what signature type is defined). When you sign with pad, the document viewing mode will be used. When true (and not signing with pad), the document is shown on the pad until there is another signature type used (For example: Document is shown on the pad, then you click on start signing and choose signature type HTML-Signer → the pad will go in standby mode). Default is false. | X | |
| signature_timeout_ms | 3000 | defines the timeout/pause in milliseconds before a pad signature is automatically completed (without pressing confirm button). Default: 3000 | X |
Certificates, Seals and signing
Keys that contain "aws_kms" refer to Amazon Web Services (AWS) Key Management Service.
| key | example | description | frigg | braga |
|---|---|---|---|---|
| api_id_iv | ghksau981ghksau9 | a secure random iv is created and stored in the db on server startup (recommended). This value is used for url data encryption. This mechanism can be overridden by setting a static 16 character long string. When used api_id_key also has to be set. | X | |
| api_id_key | zeuwipahsjd6389a | a secure random key is created and stored in the db on server startup (recommended). This value is used for url data encryption. This mechanism can be overridden by setting a static 16 character long string. When used api_id_iv also has to be set. | X | |
| app_signature_certificate_filename | d:\frigg\data\app_signature_public.der | the certificate path for the app signature with token authentication | X | |
| app_signature_certificate_password | dsf433dreE&% | the certificate password for the app signature with token authentication | X | |
app_signature_certificate_private_key_filename | d:\frigg\data\app_signature_certificate.pfx | the certificate private key path for the app signature with token authentication | X | |
| enduser_certificate_duration | 36 | the lifetime of user certificates in months | X | |
| enduser_certificate_key_length | 2048 | the length of the create user certificates | X | |
| external_certificate_provider | nebula | semicolon seperated list of external certificate providers. currently supported: nebula (nebulaSUITE) | X | |
| guest_certificate_password | kkwJk34$ldP% | the guest certificate password (for non-registered webSignatureOffice user certificates) | X | X |
| intermediate_certificate_filename | /frigg/data/cert.pem | the full path to the intermediate certificate for user certificate creation | X | |
| intermediate_certificate_password | sduiSUm7$%&hJ | the intermediate certificate password | X | |
| intermediate_certificate_private_key_filename | /frigg/data/cert_private.pem | the full path to the internmediate certificate private key | X | |
| nebula_exclude_authenticators | MAIL;SMS | semicolon seperated list of authentication methods. The listed methods won't be usable. Default: All methods allowed. | X | |
| notaryInfo | \n======================( NotaryInfo )====================== \n \nSomebody | the notary info added to a biometric signature | X | |
| notary_public_key | dshkskdhNSSKhjadsbndskKJHKHSAK \ | the public key base64 encoded that is assigned new registered users. This key is used by the web signature office apps and HTML-Signer. for more information see Notary Key | X | |
deprecated
| X | |||
| notary_sha1_fingerprint | dgdfgdfgffffffffffffffffffffffffffffffff | a sha1 hash of the certificate of the notary_public_key. It is configured in braga and used to check if the certificate configured in frigg coresponds to the hash. for more information see Notary Key | X | |
| openssl_run_directory | c:/temp | the path to a folder in which openssl can run | X | |
| rsa_encryptor_access_allow | https://somehost.stpover.de | if the rsa encryptor is accessed from a host that gets blocked because of cors, or access should be restricted, the Access-Control-Allow-Origin header can be set with this value, default is *. | ||
deprecated
for more information see Notary Key | X | |||
| https://host:8444/RsaEncryptor/encode | deprecated
| X | ||
| tsaServer | http://somehost.de/tsa | The Timestamp Authority Server used to set the signing time, braga. If not set, no timestamp |
Multitenant
| key | example | description | frigg | braga |
|---|---|---|---|---|
| multitenant | true / false: activates multitenant mode. | X | X | |
| multitenant_admin_key | Administrator authorization for adding new tenants. This string has to be sent with the POST request to create a new tenant. | X | ||
| multitenant_host_ip | ip of the multitenant host | X |
Additional server settings
...
| key | example | description | frigg | braga |
|---|---|---|---|---|
| api_deactivate_request_signature | true/false | If true, no X-SOSIGNATURE header is necessary. Only for testing! | ||
| api_id_cache_expire_minutes | 15 | the decrypted ids are kept in a cache to improve performance. This defines the time till the value expires, default is 10 minutes | X | |
| api_id_cache_max_size | 5000 | the decrypted ids are kept in a cache to improve performance. This defines the maximum capacity, if reached values are removed, default 1000 | ||
deprecated
| X | |||
| axis_server_context | /braga | The folder inside which the braga app is deployed (default empty) | X | |
| axis_server_ip | 192.168.5.56 | the IP or hostname of the braga server | X | |
| axis_server_port | 8080 | the braga server port (default 8080) | X | |
| axis_server_protocol | https | https or https, the protocol used for the braga server (default http) | X | |
| braga_create_copy | true | creates a copy of the PDF without biodata (if flag is true); default false | X | |
| braga_render_dpi | 200 | the dpi with which pages are rendered (default is 200) | X | |
| cookie_name | SOSESSIONID | the cookie name for the session cookie | X | |
| cookie_path | / | the cookie path | X | |
| file_upload_max_file_size | 20480 | the maximum upload size in bytes | X | |
| file_upload_url | https://host/fileUpload/fileUpload | the url for the file upload (via tyrservice) | X | |
| guest_user_document_availability | 60 | The time a document / envelope is available for a guest user (email guest user link). The timespan is the config setting + the signature_request due date. | ||
| logging_debug | true | enables extended logging for debugging (default false) | X | |
| max_message_size | 20480 | the max tyrservice message size (optional value) | X | |
| memcached_port | 11211 | the memcached port | X | X |
| memcached_server | 192.168.5.57 | the ip or hostname of the memcached server if memcahe is used | X | X |
| memcached_sessions | true | true or false, the switch if memcached should be used for session managemeant | X | X |
| org_quartz_properties | quartz.properties | the name of the quartz scheduler configuration file in the classpath (for the automated jobs) | X | |
| pdf_render_max_render_threads | 4 | the max number of render threads | X | |
| process_pool_timeout | 120000 | timeout for a process from the process pool in milliseconds (default 120000) | X | |
render_strategy | AllPages | the strategy used to render the pdf pages, possible values are OnlyPagesWithSignatures, AllPages, FirstTwoAndPagesWithSignatures. Default is FirstTwoAndPagesWithSignatures | X | |
| request_lifetime | 7200 | the request lifetime in seconds. | X | |
| rest_api_allowed_hosts | localhost,192.168.5.2,192.168.5.5 | the allowed hosts for the communication with the REST API (Cross-Origin-Requests) | X | |
| session_sync | 60 | session sync interval in seconds (memcached) | X | |
| session_timeout | 6000 | session timout in milleseconds (browser and tyrservice session) | X | X |
| storage_home | X:/data/ | the full path for storage of documents and certificates (BRAGA) | X | |
| storage_mode | soll rein? description korrekt? ---> | storage mode of braga, possible values:
| X | X |
| tracking-header | x-idheader | the name of the http header used for the additional tracking id logging. Default is x-tracking | X | |
| tyrservice_debugging | true | true or false, enables an extended logging for tyrservice classes (if no value is set the default is false) | X | |
| tyrservice_public | false | true or false, wether the public tyrservice services should be available, public services only use the adhoc code for authentication | X | |
url_handler_key | jdksleuwiojdksleuwio67 | on server startup a secure key is created for url encryption and stored in the db (recommended). This mechanism can be overridden with this static 32 character long string. | X | |
| webso_events_url | https://www.testserver.com/CallbackServlet | WebSignatureOffice can be configured to call an URL on certain events. This functionality is activated by setting the URL to be called in the config.ini Further configuration options are: webso_events_filter: a semicolon separated list of events that should be fired, if this option is not set, all events are fired. (e.g. STATUS_CHANGE;USER_FINISH) webso_events_keys: a semicolon seperated list of HTTP-request property keys for the webso_event execution (e.g. user;pass) webso_events_values: a semicolon seperated list with corresponding values for the webso_event_keys (e.g. stepovercallback;strongPassword) event_keys and events_values must be in the same order webso_events_retry: the time waited in milli seconds untill the event call is repeated. (e.g. 10)
| X |
...