Frontend configuration¶
Configuration¶
The configuration file is located at config/frontend.ini in the installation
directory.
Note
Detailed meaning of each field in config/frontend.ini:
| Section | Key | Type | Default | Description |
|---|---|---|---|---|
| log | syslog | integer |
0 | enable rsyslog (experimental) |
| prefix | string |
irma-frontend: | prefix to append to rsyslog entries | |
| debug | boolean |
False | enable Debug log | |
| sql_debug | boolean |
False | enable SQL debug log | |
| sqldb | username | string |
database username | |
| password | string |
database password | ||
| host | string |
database host | ||
| port | integer |
database port | ||
| dbname | string |
database name | ||
| tables_prefix | string |
database tables prefix | ||
| samples_storage | path | string |
Samples storage path | |
| celery_brain | timeout | integer |
60 (sec) | time before considering that the brain has timed-out |
| celery_frontend | timeout | integer |
30 (sec) | time before considering that the frontend has timed-out |
| celery_options | concurrency | integer | 0 | number of concurrent workers (0 means nb of cores) |
| soft_time_limit | integer |
300 (sec) | time limit before task soft interrupt | |
| time_limit | integer |
1500 (sec) | time limit before task is killed | |
| beat_schedule | string |
/var/irma/fronte nd_beat_schedule | celery beat schedule file | |
| broker_brain | host | string |
hostname for the RabbitMQ server | |
| port | integer |
5672 | port for the RabbitMQ server | |
| vhost | string |
virtual host configured for brain | ||
| username | string |
username used for brain on the RabbitMQ server | ||
| password | string |
password used for brain on the RabbitMQ server | ||
| queue | string |
queue to poll new tasks on the RabbitMQ server | ||
| broker_frontend | host | string |
hostname for the RabbitMQ server | |
| port | integer |
5672 | port for the RabbitMQ server | |
| vhost | string |
virtual host configured for this frontend | ||
| username | string |
username used for this frontend on the RabbitMQ server | ||
| password | string |
password used for this frontend on the RabbitMQ server | ||
| queue | string |
queue to poll new tasks on the RabbitMQ server | ||
| ftp | protocol | string |
“sftp” | choose File Transfer Protocol (“sftp” or “ftps”) |
| ftp_brain | host | string |
hostname for the FTP server | |
| port | integer |
22 | port for the FTP server | |
| auth | string |
“password” | SFTP authentication method (“password” or “key”) | |
| key_path | string |
sftp private key absolute path | ||
| username | string |
username used by this frontend on the FTP server | ||
| password | string |
password used by this frontend on the FTP server | ||
|
|
string |
“0” | remove file when not scanned for givent time 0 means disabled (“1 hour”, “5 days”, “3w”, “1year”) |
|
string |
0 | cron hour settings | |
| clean_fs_age _cron_minute | string |
0 | cron minute settings | |
| clean_fs_age _cron_day_of_week | string |
* | cron day of week settings | |
|
|
string |
“0” | space’s maximum size dedicated to the file system (“100 Mb”, “512 Mb”, “1.5Gb”) |
|
string |
* | cron hour settings | |
| clean_fs_size _cron_minute | string |
0 | cron minute settings | |
| clean_fs_size _cron_day_of_week | string |
* | cron day of week settings | |
| interprocess _lock | path | string |
/var/run/lock/ir ma-frontend.lock | Concurrency file lock |
| ssl_config | activate_ssl | boolean |
False | Enable RabbitMQ ssl |
| ca_certs | string |
RabbitMQ SSL certs | ||
| keyfile | string |
RabbitMQ SSL keyfile | ||
| certfile | string |
RabbitMQ SSL certfile |
Note
The default path for samples is /var/irma/samples/ make sure it exists with correct rights for irma user before launching your first scan.