Blixt Documentation v2.11

Settings are grouped by the section they belong to in the YAML file. Most also have a command-line flag, listed by --help. See Configuration for how the file, environment and flags combine.

general

Setting Default Meaning
default_cloud Provider for bucket names written without a scheme: aws, gcp, azure, oracle, minio, cloudflare, coreweave. Defaults to the first bucket cloud provider if not set.

cloud

Setting Default Meaning
pubsub_enabled true Default for change notifications; a bucket’s own pubsub/nopubsub wins
write_probe true Check at startup whether the credentials can write, and serve the bucket read-only if not
strict_bucket_access false Fail startup, instead of serving read-only, when a bucket can’t be written
event_log.enabled false Turn on the event log
event_log.retention_minutes 60 How long event-log entries are kept
<provider>.credentials Path to the provider’s credentials file
<provider>.project Project, account or organization the buckets belong to
<provider>.buckets List of buckets: see Buckets
<provider>.all_buckets false Serve every bucket the credentials can list
<provider>.name aws gcp … Name of the cloud provider’s directory in the mount root. A single path component, distinct from the other clouds’ names.
aws.profile, oracle.profile Profile in the provider’s configuration file. AWS’s default profile, or Oracle’s DEFAULT, when not set.
aws.access_key, aws.secret_key, aws.session_token An AWS key pair, used in place of the configuration files. Never sent to other servers.
azure.account_key, azure.sas_token A storage account key or shared access signature, used in place of an Azure sign-in. Never sent to other servers.

disk and cache

Setting Default Meaning
disk.persistent_prefix /data Where persistent state lives
disk.ephemeral_prefix /data Where rebuildable state (cache) lives
cache.enable_compression true Compress data stored in read cache
cache.stop_new_files_percent 95 Refuse writes that start a new file above this disk use
cache.stop_write_percent 98 Refuse every write above this disk use
cleaner.target_percent 90 Read cache disk cleaner’s target usage

file

Setting Default Meaning
write_session_idle_seconds 30 How long an NFSv3 write session may sit idle before BlixtFS closes and uploads it. NFSv3 clients never send a close of their own.
write_session_commit_idle_seconds 5 The same, for a session the client has already committed.
write_session_abandoned_seconds 0 Close any write session idle this long, on every protocol. 0 turns it off.
shutdown_drain_seconds 60 How long a stopping server waits for staged writes to finish uploading. 0 does not wait. Writes still pending upload on the next start. The container’s stop timeout (docker stop -t, Compose stop_grace_period) must be longer.

indexing

Setting Default Meaning
workers 32 Parallel listing workers
lazy false Make every bucket lazy
bucket_discovery true Serve a bucket a client looks up by name, after probing it
bucket_removal true Let clients stop serving a bucket through bfs.remove_bucket
background_objects_per_second 2000 Pace background indexing (the crawl, the periodic sweep, requested checks) so it yields to clients. 0 means no limit.
fsck_sleep_seconds 3600 Interval between periodic consistency checks
fix_database_issues true Allow checks to repair the index
fix_grace_minutes 60 Leave recently changed files alone
fix_issues false Allow checks to write to or delete from the bucket
user_fsck true Let users request checks by setting the bfs.fsck extended attribute.
manual_fsck_cooldown_seconds 300 Minimum time between requested checks of one path

filesystem

Setting Default Meaning
default_uid the server’s user Owner of files with no recorded owner
default_gid the server’s group Group of files with no recorded group
default_file_mode 0644 Mode of files with no recorded mode
default_directory_mode 0755 Mode of directories with no recorded mode

These apply to buckets created after they change. A bucket’s own uid, gid, file_mode and dir_mode attributes override them: see Default owner and permissions.

nfs, smb, sftp

See Protocols.

monitoring

Setting Default Meaning
allowed_cidrs Networks allowed to reach the metrics endpoints

local

Settings for one particular process.

Setting Default Meaning
hostname localhost Hostname.