app.conf.example

[app]
# Loglevel can be one of: debug, info, warning, error, critical
loglevel=debug
# list of possible scopes according to the NVI 
scopes = nvi:create nvi:read nvi:update nvi:delete nvi:localize 

[logging]
# All keys are optional. When syslog_path is omitted, logs only go to stdout.
# Single syslog channel in host:port format (UDP). All streams (app, siem,
# public_inspect, debug) are sent here; each JSON record carries a stream_id
# field so the log server can tell them apart.
syslog_path = syslog:5514
# Identifies this application in the JSON records (application_id field),
# so the log server can tell apart applications sharing the channel.
application_id = nvi-beheer-api
# Include exception/stack traces in JSON logs
include_traces = True
# Whether to display debug logs in the console
debug_logs_in_console = True

[database]
# Dsn for database connection
dsn=postgresql+psycopg://postgres:postgres@postgres:5432/postgres
# Retry backoff (in seconds) for database connection
retry_backoff=0.1, 0.2, 0.4, 0.8, 1.6, 3.2, 4.8, 6.4, 10.0
# Connection pool size, use 0 for unlimited connections
pool_size=5
# Max overflow for connection pool
max_overflow=10
# Pre ping the connection before using it
pool_pre_ping=False
# Recycle the connection after this time (in seconds)
pool_recycle=1800

[telemetry]
# Telemetry is enabled or not
enabled = False
# Endpoint to GRPC server for telemetry
endpoint = http://tracing:4317
# Service name to use
service_name = NVI Beheer API
# Tracer name to use
tracer_name = zmodules.service.nvi_beheer_api

[stats]
# Statsd is enabled or not
enabled = False
# Host for statsd server
host = 127.0.0.1
# Port for statsd server
port = 8125
# Module name for statsd
module_name = nvi-beheer-api


[uvicorn]
# If true, the api docs will be enabled
swagger_enabled = True
# Endpoint for swagger api docs
docs_url = /docs
# Endpoint for redoc api docs
redoc_url = /redocs
# Host for the uvicorn server
host = 0.0.0.0
# Port for the uvicorn server
port = 8502
# Live reload for uvicorn server
reload = True

# SSL configuration
use_ssl = False
ssl_base_dir = secrets/ssl
ssl_cert_file = server.cert
ssl_key_file = server.key