Skip to content

Configuration

arkel index and arkel storage can be started from a TOML file instead of passing every flag:

sh
arkel index   --config /etc/arkel/arkel-node.toml
arkel storage --config /etc/arkel/arkel-node.toml

--config and --data-dir are global flags. For every key the precedence is:

command-line flag → config file → built-in default

[index_nodes]

KeyTypeFlagNotes
http_addrstring--http-addrAddress the HTTP API binds to (default 127.0.0.1:8001)
data_dirstring--data-dirIdentities, Raft log, and SQLite state
peersarray of strings--peer-addressesCluster members as pubkey@ip:port; self-entries are filtered at startup

[storage]

KeyTypeFlagNotes
addrstring--addrAddress the iroh QUIC endpoint binds to (default 127.0.0.1:9001)
advertise_addrstring--advertise-addrAddress registered with the index (defaults to addr)
data_dirstring--data-dirIdentity and blob store
index_addrsarray of strings--index-addrsIndex HTTP URLs; the registrar discovers the current Raft leader among them
capacitystring--capacityAllocation committed to the network, e.g. "1TB" (default 1TB)
gc_interval_secsinteger--gc-interval-secsSeconds between garbage-collection scans

Example

toml
# --- index node ---
[index_nodes]
http_addr = "0.0.0.0:8001"
data_dir = "/var/lib/arkel/index-8001"
# Every node lists the same cluster; self-entries are filtered at startup.
peers = [
  "peer1@10.0.0.11:8001",
  "peer2@10.0.0.12:8001",
  "peer3@10.0.0.13:8001",
]

# --- storage node ---
[storage]
addr = "0.0.0.0:9001"
data_dir = "/var/lib/arkel/storage-9001"
index_addrs = [
  "http://10.0.0.11:8001",
  "http://10.0.0.12:8001",
  "http://10.0.0.13:8001",
]
# advertise_addr = "1.2.3.4:9001"
# gc_interval_secs = 3600

Sizes

capacity accepts a suffix ("1TB", "500GB", "1G") or a raw byte count ("1048576").

Identity

A node's identity is an iroh keypair generated on first boot and persisted in its data_dir (identity.key). The node's network address and Raft ID derive from it, so keep it stable and back it up.

See the CLI reference for the full flag surface.