This configuration file specifies settings for various components of the Pebblo.
port
: Specifies the port number on which the Pebblo server listens for incoming connections.host
: Specifies the host address on which the Pebblo server to run.
Notes:
- By default
Pebblo Server
runs atlocalhost:8000
. When we change values ofport
and/orhost
, thePebblo Safe DataLoader
env variablePEBBLO_CLASSIFIER_URL
needs to set to the correct URL. - By default
Pebblo UI
runs atlocalhost:8000/pebblo
. When we change values ofport
and/orhost
, the Pebblo UI would be running on the respectivehost:port/pebblo
.
level
: Sets the logging level. Possible values are 'info', 'debug', 'error', 'warning', and 'critical'. Default value isinfo
.file
: Sets the log file path. Default value is/tmp/logs/pebblo.log
.maxFileSize
: Sets the maximum size of the log file. Default value is8306688
bytes (8 MB).backupCount
: Sets the number of backup files to keep. Default value is3
.
-
format
: Specifies the format of generated reports. Available options include 'pdf'. -
renderer
: Specifies the rendering engine for generating reports. Options include 'weasyprint', 'xhtml2pdf'.Note
Note: Using xhtml2pdf gives a report with basic UI elements, but WeasyPrint renderer creates a sleeker, better-aligned interface for your PDFs. See image below. If you put renderer asweasyprint
, then you need to install Pango. Follow these instructions for the same. -
cacheDir
: Sets the directory where pebblo stores metadata, generated reports, and other temporary files. Default value is~/.pebblo
. -
outputDir
: Deprecated. UsecacheDir
instead.
anonymizeSnippets
: Flag to anonymize snippets in report. Possible values are 'True' and 'False'. When its value is 'True', snippets in reports will be shown as anonymized and vice versa.
daemon:
port: 8000
host: localhost
logging:
level: info
reports:
format: pdf
renderer: xhtml2pdf
outputDir: ~/.pebblo
classifier:
anonymizeSnippets: False
Note
:
Users have the option to maintain any section or even a single field within a section. For instance, the config
file might appear as follows:
logging:
level: info
This flexibility empowers users to tailor configurations to their specific needs while retaining default values for other sections or fields.