Configuration Reference

Liwan can be configured using a configuration file or environment variables. Configuration files are written in TOML format. Liwan tries to load the configuration file from the current directory (or ~/.config/liwan/liwan.config.toml on linux/macos) by default. Alternatively, you can use the --config flag or the LIWAN_CONFIG environment variable to specify a path to the configuration file.

To generate a default configuration file, you can run liwan generate-config (or liwan generate-config -o OUTPUT_PATH), which will create a liwan.config.toml file in the current directory with the following content:

# The base URL of the Liwan instance
base_url="http://localhost:9042"

# The port to listen on (http)
port=9042

# Disable fetching favicons for websites using DuckDuckGo's favicon service
# disable_favicons=true

# # Folder to store the database in (Will be created if it doesn't exist)
# # defaults to $HOME/.local/share/liwan/data on linux/macos
# # defaults to ./liwan-data on other platforms
# data_dir="./liwan-data"

# GeoIp settings (Optional)
[geoip]
# # MaxMind account ID and license key
# # Required to automatically download the database and keep it up to date
# maxmind_account_id="MY_ACCOUNT_ID"
# maxmind_license_key="MY_LICENSE_KEY"
# maxmind_edition="GeoLite2-City"

# # If you don't want to automatically download the database, you can specify a path to a local file
# # Otherwise, the database will be downloaded automatically and stored in the data_dir
# maxmind_db_path="/path/to/GeoLite2-City.mmdb"

Configuration Options

TOML Key	Environment Variable	Default
`base_url`	`LIWAN_BASE_URL`	(none)
`data_dir`	`LIWAN_DATA_DIR`	`./liwan-data`
`port`	`LIWAN_PORT`	`9042`
`disable_favicons`	`LIWAN_DISABLE_FAVICONS`	`false`
`geoip.maxmind_account_id`	`LIWAN_MAXMIND_ACCOUNT_ID`	(none)
`geoip.maxmind_license_key`	`LIWAN_MAXMIND_LICENSE_KEY`	(none)
`geoip.maxmind_edition`	`LIWAN_MAXMIND_EDITION`	`GeoLite2-City`
`geoip.maxmind_db_path`	`LIWAN_MAXMIND_DB_PATH`	(none)
`duckdb.memory_limit`	`LIWAN_DUCKDB_MEMORY_LIMIT`	(none)
`duckdb.threads`	`LIWAN_DUCKDB_THREADS`	(core count)