mirror of
https://github.com/hanzoai/index.git
synced 2026-10-30 18:34:27 +00:00
zeekayandHanzo Dev
bc3e6b2a5d
Same rule as before, three more shapes of it. These were not caught the first
time because they are not `git =` dependencies — they are links inside strings
the server actually SERVES:
- `github.com/orgs/index/discussions/N` (was meilisearch) appears in ~25
experimental-feature error bodies and every `issue_link`. A user who
enables a feature and reads the error was being sent to a 404.
- `bench.index.dev` is upstream's benchmark dashboard, referenced from
BENCHMARKS.md and one comment. We do not run one; naming theirs is
accurate.
An upstream URL is provenance. It says where something came from or where it
is documented, and a rebrand has no business editing it.
Co-authored-by: Hanzo Dev <[email protected]>
135 lines
5.8 KiB
TOML
135 lines
5.8 KiB
TOML
# This file shows the default configuration of Hanzo Index.
|
|
# All variables are defined here: https://www.hanzo.ai/docs/learn/configuration/instance_options#environment-variables
|
|
|
|
# Designates the location where database files will be created and retrieved.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#database-path
|
|
db_path = "./data.ms"
|
|
|
|
# Configures the instance's environment. Value must be either `production` or `development`.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#environment
|
|
env = "development"
|
|
|
|
# The address on which the HTTP server will listen.
|
|
http_addr = "localhost:7700"
|
|
|
|
# Sets the instance's master key, automatically protecting all routes except GET /health.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#master-key
|
|
# master_key = "YOUR_MASTER_KEY_VALUE"
|
|
|
|
# Deactivates Hanzo Index's built-in telemetry when provided.
|
|
# Hanzo Index automatically collects data from all instances that do not opt out using this flag.
|
|
# All gathered data is used solely for the purpose of improving Hanzo Index, and can be deleted at any time.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#disable-analytics
|
|
# no_analytics = true
|
|
|
|
# Sets the maximum size of accepted payloads.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#payload-limit-size
|
|
http_payload_size_limit = "100 MB"
|
|
|
|
# Defines how much detail should be present in Hanzo Index's logs.
|
|
# Hanzo Index currently supports six log levels, listed in order of increasing verbosity: `OFF`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#log-level
|
|
log_level = "INFO"
|
|
|
|
# Sets the maximum amount of RAM Hanzo Index can use when indexing.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#max-indexing-memory
|
|
# max_indexing_memory = "2 GiB"
|
|
|
|
# Sets the maximum number of threads Hanzo Index can use during indexing.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#max-indexing-threads
|
|
# max_indexing_threads = 4
|
|
|
|
#############
|
|
### DUMPS ###
|
|
#############
|
|
|
|
# Sets the directory where Hanzo Index will create dump files.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#dump-directory
|
|
dump_dir = "dumps/"
|
|
|
|
# Imports the dump file located at the specified path. Path must point to a .dump file.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#import-dump
|
|
# import_dump = "./path/to/my/file.dump"
|
|
|
|
# Prevents Hanzo Index from throwing an error when `import_dump` does not point to a valid dump file.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ignore-missing-dump
|
|
ignore_missing_dump = false
|
|
|
|
# Prevents an index instance with an existing database from throwing an error when using `import_dump`.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ignore-dump-if-db-exists
|
|
ignore_dump_if_db_exists = false
|
|
|
|
|
|
#################
|
|
### SNAPSHOTS ###
|
|
#################
|
|
|
|
# Enables scheduled snapshots when true, disable when false (the default).
|
|
# If the value is given as an integer, then enables the scheduled snapshot with the passed value as the interval
|
|
# between each snapshot, in seconds.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#schedule-snapshot-creation
|
|
schedule_snapshot = false
|
|
|
|
# Sets the directory where Hanzo Index will store snapshots.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#snapshot-destination
|
|
snapshot_dir = "snapshots/"
|
|
|
|
# Launches Hanzo Index after importing a previously-generated snapshot at the given filepath.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#import-snapshot
|
|
# import_snapshot = "./path/to/my/snapshot"
|
|
|
|
# Prevents an index instance from throwing an error when `import_snapshot` does not point to a valid snapshot file.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ignore-missing-snapshot
|
|
ignore_missing_snapshot = false
|
|
|
|
# Prevents an index instance with an existing database from throwing an error when using `import_snapshot`.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ignore-snapshot-if-db-exists
|
|
ignore_snapshot_if_db_exists = false
|
|
|
|
|
|
###########
|
|
### SSL ###
|
|
###########
|
|
|
|
# Enables client authentication in the specified path.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-authentication-path
|
|
# ssl_auth_path = "./path/to/root"
|
|
|
|
# Sets the server's SSL certificates.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-certificates-path
|
|
# ssl_cert_path = "./path/to/certfile"
|
|
|
|
# Sets the server's SSL key files.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-key-path
|
|
# ssl_key_path = "./path/to/private-key"
|
|
|
|
# Sets the server's OCSP file.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-ocsp-path
|
|
# ssl_ocsp_path = "./path/to/ocsp-file"
|
|
|
|
# Makes SSL authentication mandatory.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-require-auth
|
|
ssl_require_auth = false
|
|
|
|
# Activates SSL session resumption.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-resumption
|
|
ssl_resumption = false
|
|
|
|
# Activates SSL tickets.
|
|
# https://www.hanzo.ai/docs/learn/configuration/instance_options#ssl-tickets
|
|
ssl_tickets = false
|
|
|
|
#############################
|
|
### Experimental features ###
|
|
#############################
|
|
|
|
# Experimental metrics feature. For more information, see: <https://github.com/hanzoai/index/discussions/3518>
|
|
# Enables the Prometheus metrics on the `GET /metrics` endpoint.
|
|
experimental_enable_metrics = false
|
|
|
|
# Experimental RAM reduction during indexing, do not use in production, see: <https://github.com/meilisearch/product/discussions/652>
|
|
experimental_reduce_indexing_memory_usage = false
|
|
|
|
# Experimentally reduces the maximum number of tasks that will be processed at once, see: <https://github.com/orgs/meilisearch/discussions/713>
|
|
# experimental_max_number_of_batched_tasks = 100
|