Settings Documentation

Help

List top-level commands or get details for a specific one. For namespaced subcommands (contact, contact currency), eiou help delegates to the namespace's own help so eiou contact and eiou help contact print identical subcommand trees.

Top-level commands: info, overview, send, viewbalances, history, viewsettings, changesettings, sync, updatecheck, shutdown, start, restart, verify-chain, report.

Namespaces: contact, backup, apikey, payback, chaindrop, request, p2p, plugin, dlq.

eiou help

Show the full list of top-level commands and namespaces, with a one-line summary of each. Run this when you want a directory of what's available.

eiou help

eiou help <command>

Show detailed help for a specific top-level command. Works for send, info, history, etc. Does not drill into namespace subcommands — those are reached via the namespace itself.

eiou help send

Namespace help

Run the namespace name on its own (or its help subcommand) for the full subcommand tree. There is no eiou help contact add form — drill into the namespace and read the subcommand line you want.

eiou contact

eiou backup help

Global options

Every CLI command accepts two output-formatting flags. JSON output is intended for the REST/automation surface — if you're driving the wallet from another program, use these; if you're reading at the terminal, leave them off.

--json, -j — emit the response as a structured JSON envelope. The shape is documented in the API reference.
--no-metadata — omit the metadata block (timestamp, node id, command name) from the JSON envelope. Only meaningful with --json.

View settings

Print the full configuration grouped by category: transaction defaults, P2P & network, feature toggles, backup & logging, data retention, rate limiting, display, and currency management.

Example

eiou viewsettings

Change settings

Run with no arguments to enter interactive mode (numbered menu of every changeable setting), or pass <setting> <value> for a direct change. The setting key is case-sensitive (camelCase). See the catalog below for every available key.

ExampleNo arguments — opens the interactive numbered menu of every changeable setting.

eiou changesettings

Direct change — sets defaultFee to 0.5 (a percentage value).

eiou changesettings defaultFee 0.5

Change the node's hostname — also derives the matching HTTPS URL and regenerates the SSL cert.

eiou changesettings hostname http://alice

Numeric setting where 0 is the "unlimited" sentinel — here, no display-line cap.

eiou changesettings maxOutput 0

Comma-separated list value — quote it so the shell passes the whole string as one argument.

eiou changesettings allowedCurrencies "VWL,EUR"

Wipe every saved setting back to compile-time defaults — --yes is required (the bare reset form errors out).

eiou changesettings reset --yes

Reset: eiou changesettings reset --yes wipes every saved setting back to compile-time defaults. Identity fields (keys, hostnames, onion address), contacts, transactions, backups, and API keys are not touched. The bare reset form prints a safety error.

Hostname: setting hostname derives the matching HTTPS URL automatically and regenerates the SSL certificate.

Settings catalog

Every key accepted by changesettings, grouped by category. true/false is accepted for booleans. Decimal fees are percentages (0.01 = 0.01%). Minimums noted as "min N" are validated by the wallet.

Transaction & fees

SettingDescriptionExample

defaultFeeDefault fee % for new contacts0.01

defaultCreditLimitDefault credit limit for new contacts100

defaultCurrencyDefault currency codeVWL

minFeeMinimum fee floor (0 = free relaying)0.00000001

maxFeeMaximum fee % allowed5.0

allowedCurrenciesComma-separated allowed currenciesVWL,EUR

autoRejectUnknownCurrencyAuto-reject contact requests with disallowed currenciestrue

P2P & network

SettingDescriptionExample

maxP2pLevelMaximum P2P routing hops3

p2pExpirationP2P route timeout (s); txs get +120s delivery window300

directTxExpirationDirect (non-P2P) tx delivery timeout (s); 0 = no expiry120

autoAcceptTransactionAuto-accept P2P txs when a route is foundtrue

defaultTransportModePreferred transport when name has no schemehttp / https / tor

hostnameNode hostname (regenerates SSL cert)http://alice

nameDisplay name for this nodeAlice

trustedProxiesTrusted proxy IPs/CIDRs (comma-separated)10.0.0.1,172.16.0.0/12

hopBudgetRandomizedRandomize P2P hop depth for privacytrue

httpTransportTimeoutSecondsHTTP transport timeout (5–120)15

torTransportTimeoutSecondsTor transport timeout (10–300)30

torCircuitMaxFailuresConsecutive Tor failures before cooldown (1–10)3

torCircuitCooldownSecondsCooldown after max failures (60–3600)300

torFailureTransportFallbackFall back to HTTP/HTTPS when Tor failstrue

torFallbackRequireEncryptedOnly fall back to HTTPS, never plain HTTPtrue

apiEnabledEnable REST API endpointtrue

apiCorsAllowedOriginsAllowed CORS origins for APIhttps://example.com

rateLimitEnabledToggle rate limiting (CLI/API only)true

Feature toggles

SettingDescriptionExample

contactStatusEnabledEnable contact status (ping) trackingtrue

contactStatusSyncOnPingSync chains during pingtrue

autoChainDropProposeAuto-propose tx-drop when sync can't repair a gaptrue

autoChainDropAcceptAuto-accept incoming tx-drop proposalsfalse

autoChainDropAcceptGuardBalance guard for auto-accept tx dropstrue

autoAcceptRestoredContactAuto-accept restored contacts on wallet restorefalse

autoBackupEnabledEnable scheduled daily backupstrue

analyticsEnabledShare anonymous usage stats (opt-in)false

Backup & logging

SettingDescriptionExample

backupRetentionCountBackup files to keep (per prefix; min 1)3

backupCronHourBackup schedule hour UTC (0–23)0

backupCronMinuteBackup schedule minute (0–59)0

logLevelMinimum log levelINFO

logMaxEntriesMax log entries to keep (min 10)100

Data retention & archival

SettingDescriptionExample

cleanupDeliveryRetentionDaysDays to retain delivery records (min 1)30

cleanupDlqRetentionDaysDays to retain DLQ entries (min 1)90

cleanupHeldTxRetentionDaysDays to retain held transactions (min 1)7

cleanupRp2pRetentionDaysDays to retain P2P routing records (min 1)30

cleanupMetricsRetentionDaysDays to retain metrics (min 1)90

paymentRequestsArchiveRetentionDaysDays before resolved payment requests are archived180

paymentRequestsArchiveBatchSizeMax rows per archival run (min 1)500

transactionsArchiveRetentionDaysDays before completed transactions are archived30

transactionsArchiveBatchSizeMax rows moved per pair per run500

Rate limiting

SettingDescriptionExample

p2pRateLimitPerMinuteMax P2P requests per minute60

rateLimitMaxAttemptsAttempts before rate limit triggers10

rateLimitWindowSecondsRate-limit window (s)60

rateLimitBlockSecondsBlock duration after limit hit (s)300

Display

SettingDescriptionExample

maxOutputMax display lines (0 = unlimited)50

displayDecimalsDisplay decimals 0–8 (truncates, never rounds up)2

displayDateFormatPHP date format stringY-m-d H:i:s.u