Skip to content

Latest commit

 

History

History
129 lines (122 loc) · 14.6 KB

frontend.rst

File metadata and controls

129 lines (122 loc) · 14.6 KB

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

------------------+

prefix

------------------+

debug

------------------+

sql_debug

integer

------------+

string

------------+

boolean

------------+

boolean

0

----------------+

irma-frontend:

----------------+

False

----------------+

False

enable rsyslog (experimental)

---------------------------------------------------------+

prefix to append to rsyslog entries

---------------------------------------------------------+

enable Debug log

---------------------------------------------------------+

enable SQL debug log

+

sqldb +

username

------------------+

password

------------------+

host

------------------+

port

------------------+

dbname

------------------+

tables_prefix

string

------------+

string

------------+

string

------------+

integer

------------+

string

------------+

string

----------------+

----------------+

----------------+

----------------+

----------------+

database username

---------------------------------------------------------+

database password

---------------------------------------------------------+

database host

---------------------------------------------------------+

database port

---------------------------------------------------------+

database name

---------------------------------------------------------+

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

------------------+

soft_time_limit

------------------+

time_limit

------------------+

beat_schedule

integer

------------+

integer

------------+

integer

------------+

string

0

----------------+

300 (sec)

----------------+

1500 (sec)

----------------+ /var/irma/fronte nd_beat_schedule

number of concurrent workers (0 means nb of cores)

---------------------------------------------------------+

time limit before task soft interrupt

---------------------------------------------------------+

time limit before task is killed

---------------------------------------------------------+

celery beat schedule file

+

broker_brain

host

------------------+

port

------------------+

vhost

------------------+

username

------------------+

password

------------------+

queue

string

------------+ integer ------------+ string ------------+ string ------------+ string ------------+ string

----------------+ 5672 ----------------+

----------------+

----------------+

----------------+

hostname for the RabbitMQ server

---------------------------------------------------------+

port for the RabbitMQ server

---------------------------------------------------------+

virtual host configured for brain

---------------------------------------------------------+

username used for brain on the RabbitMQ server

---------------------------------------------------------+

password used for brain on the RabbitMQ server

---------------------------------------------------------+

queue to poll new tasks on the RabbitMQ server

+

broker_frontend

host

------------------+

port

------------------+

vhost

------------------+

username

------------------+

password

------------------+

queue

string

------------+ integer ------------+ string ------------+ string ------------+ string ------------+ string

----------------+ 5672 ----------------+

----------------+

----------------+

----------------+

hostname for the RabbitMQ server

---------------------------------------------------------+

port for the RabbitMQ server

---------------------------------------------------------+

virtual host configured for this frontend

---------------------------------------------------------+

username used for this frontend on the RabbitMQ server

---------------------------------------------------------+

password used for this frontend on the RabbitMQ server

---------------------------------------------------------+

queue to poll new tasks on the RabbitMQ server

ftp

protocol

string

"sftp"

choose File Transfer Protocol ("sftp" or "ftps")

+

ftp_brain +

host

------------------+

port

------------------+

auth

------------------+

key_path

------------------+

username

------------------+

password

string

------------+ integer ------------+ string ------------+ string ------------+ string ------------+ string

----------------+ 22 ----------------+ "password" ----------------+

----------------+

----------------+

hostname for the FTP server

---------------------------------------------------------+

port for the FTP server

---------------------------------------------------------+

SFTP authentication method ("password" or "key")

---------------------------------------------------------+

sftp private key absolute path

---------------------------------------------------------+

username used by this frontend on the FTP server

---------------------------------------------------------+

password used by this frontend on the FTP server

cron_clean_file +

_age

clean_fs_max

_age

------------------+
clean_fs_age

_cron_hour

------------------+

clean_fs_age _cron_minute

------------------+

clean_fs_age _cron_day_of_week

string

------------+

string

------------+

string

------------+

string

"0"

----------------+

0

----------------+

0

----------------+

*

remove file when not scanned for givent time 0 means disabled ("1 hour", "5 days", "3w", "1year")

---------------------------------------------------------+

cron hour settings

---------------------------------------------------------+

cron minute settings

---------------------------------------------------------+

cron day of week settings

cron_clean_file +

_size

clean_fs_max

_size

------------------+
clean_fs_size

_cron_hour

------------------+

clean_fs_size _cron_minute

------------------+

clean_fs_size _cron_day_of_week

string

------------+

string

------------+

string

------------+

string

"0"

----------------+

*

----------------+

0

----------------+

*

space's maximum size dedicated to the file system ("100 Mb", "512 Mb", "1.5Gb")

---------------------------------------------------------+

cron hour settings

---------------------------------------------------------+

cron minute settings

---------------------------------------------------------+

cron day of week settings

interprocess _lock

path

string /var/run/lock/ir ma-frontend.lock Concurrency file lock

+

ssl_config +

activate_ssl

------------------+

ca_certs

------------------+

keyfile

------------------+

certfile

boolean

------------+

string

------------+

string

------------+

string

False

----------------+

----------------+

----------------+

Enable RabbitMQ ssl

---------------------------------------------------------+

RabbitMQ SSL certs

---------------------------------------------------------+

RabbitMQ SSL keyfile

---------------------------------------------------------+

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.