JSON schema for search-a-licious settings

Type: object

Settings for Search-a-licious

The most important settings is config_path.

Those settings can be overridden through environment
by using the name in capital letters.
If you use docker compose, a good way to do that
is to modify those values in your .env file.

No Additional Properties

Config Path

Default: null

Path to the search-a-licious yaml configuration file.

See Explain configuration file for more information

Type: stringFormat: path
Type: null

Elasticsearch Url

Type: string Default: "http://localhost:9200"

URL to the ElasticSearch instance

Bare in mind this is from inside the container.

Elasticsearch Request Timeout

Type: number Default: 10.0

Timeout in seconds of the requests the API sends to Elasticsearch
(search, autocomplete, document, scripts).

A request that is not answered in this time gets a 503 error,
and the worker thread is free again.
The default is the one of the Elasticsearch client.

It does not apply to imports and to the update daemon,
which set their own timeouts.

Value must be strictly greater than 0

Redis Host

Type: string Default: "localhost"

Host for the Redis instance containing event stream

Bare in mind this is from inside the container.

Redis Port

Type: integer Default: 6379

Port for the redis host instance containing event stream

Redis Reader Timeout

Type: integer Default: 5

timeout in seconds to read redis event stream

Sentry Dns

Default: null

Sentry DNS to report incident, if None no incident is reported

Type: string
Type: null

LoggingLevel

Type: enum (of string) Default: "INFO"

Log level. Accepted logging levels

  • NOTSET - means no los
  • DEBUG / INFO / WARNING / ERROR / CRITICAL
    • match standard Python logging levels

Must be one of:

  • "NOTSET"
  • "DEBUG"
  • "INFO"
  • "WARNING"
  • "ERROR"
  • "CRITICAL"

Taxonomy Cache Dir

Type: stringFormat: path Default: "data/taxonomies"

Directory where to store taxonomies before ingestion to ElasticSearch

User Agent

Type: string Default: "search-a-licious"

User-Agent used when fetching resources (taxonomies) or documents