Installation

If you're running a Citadel or Umbrel Node, you can install Oak from the node's app store.

For more advanced setups, like running an Oak container or building from source, see How to run.

---

Recurring Payments

Oak Node lets you schedule recurring payments to Lightning Addresses.

The schedule can be defined based on a so-called bcron expression (blocktime-cron). Similar to a cron expression, it can say when an event should occur, how often, and optionally from when and until when.

Further reading:

• Recurring Payments demo
• BCron Expression Syntax

---

Email and Nostr Bots

Oak Node has two bots, one usable via Email and one via the Nostr protocol.

The bots let you interact with your Oak Node using a chat interface. You can, for instance, create and pay invoices, or send sats to a LN address (full list of commands).

Both bots are disabled by default. They are each usable after an initial pairing process.

Further reading:

• Email bot
  • Email Bot demo
  • High-level Email Bot architecture
  • Detailed Email Bot setup
  • Email Bot performance tips
• Nostr bot
  • Modules

---

Advanced Configuration

On startup, the Oak node accepts several startup parameters as configuration flags. A full list can be found in params.rs.

They can be set as environment variables, by changing the variable names to uppercase and adding the OAK_ prefix. For example:

• OAK_DATA_DIR=/path/to/data-dir sets the Oak data dir to a custom path
• OAK_LND_POLLING_INTERVAL_SECONDS=120 sets the LND polling interval to 2 minutes (120 seconds)