Franz Kafka
4ec600f6c0
- Serve /opensearch.xml with configurable base URL - Browsers can now add gosearch as a search engine from the address bar - Configurable via [server] base_url or BASE_URL env var - XML template embedded in the binary via go:embed - Added base_url to config.example.toml
68 lines
2.2 KiB
TOML
68 lines
2.2 KiB
TOML
# gosearch configuration
|
|
# Copy to config.toml and adjust as needed.
|
|
# Environment variables are used as fallbacks when a config field is empty/unset.
|
|
|
|
[server]
|
|
# Listen port (env: PORT)
|
|
port = 8080
|
|
|
|
# HTTP timeout for engine and upstream calls (env: HTTP_TIMEOUT)
|
|
http_timeout = "10s"
|
|
|
|
# Public base URL for OpenSearch XML (env: BASE_URL)
|
|
# Set this so browsers can add gosearch as a search engine.
|
|
# Example: "https://search.example.com"
|
|
base_url = ""
|
|
|
|
[upstream]
|
|
# URL of an upstream SearXNG instance for unported engines (env: UPSTREAM_SEARXNG_URL)
|
|
# Leave empty to run without an upstream proxy.
|
|
url = ""
|
|
|
|
[engines]
|
|
# Comma-separated list of engines to execute locally in Go (env: LOCAL_PORTED_ENGINES)
|
|
# Engines not listed here will be proxied to upstream SearXNG.
|
|
local_ported = ["wikipedia", "arxiv", "crossref", "braveapi", "qwant", "duckduckgo", "github", "reddit", "bing"]
|
|
|
|
[engines.brave]
|
|
# Brave Search API key (env: BRAVE_API_KEY)
|
|
api_key = ""
|
|
# Optional access token to gate requests (env: BRAVE_ACCESS_TOKEN)
|
|
access_token = ""
|
|
|
|
[engines.qwant]
|
|
# Qwant category: "web" or "web-lite" (default: "web-lite")
|
|
category = "web-lite"
|
|
results_per_page = 10
|
|
|
|
[cache]
|
|
# Valkey/Redis cache for search results.
|
|
# Leave address empty to disable caching entirely.
|
|
# Env: VALKEY_ADDRESS
|
|
address = ""
|
|
# Env: VALKEY_PASSWORD
|
|
password = ""
|
|
# Database index (env: VALKEY_DB)
|
|
db = 0
|
|
# Cache TTL for search results (env: VALKEY_CACHE_TTL)
|
|
default_ttl = "5m"
|
|
|
|
[cors]
|
|
# CORS configuration for browser-based clients.
|
|
# Allowed origins: use "*" for all, or specific domains (env: CORS_ALLOWED_ORIGINS)
|
|
allowed_origins = ["*"]
|
|
# Allowed methods (default: GET, POST, OPTIONS)
|
|
# allowed_methods = ["GET", "POST", "OPTIONS"]
|
|
# Allowed headers (default: Content-Type, Authorization, X-Search-Token, X-Brave-Access-Token)
|
|
# allowed_headers = ["Content-Type", "Authorization"]
|
|
# Preflight cache duration in seconds (default: 3600)
|
|
# max_age = 3600
|
|
|
|
[rate_limit]
|
|
# Per-IP rate limiting. Set requests to 0 to disable.
|
|
# Env: RATE_LIMIT_REQUESTS
|
|
requests = 30
|
|
# Time window for rate limit (env: RATE_LIMIT_WINDOW)
|
|
window = "1m"
|
|
# How often to clean up stale IP entries (env: RATE_LIMIT_CLEANUP_INTERVAL)
|
|
cleanup_interval = "5m"
|