SIAD(1)

📦 version 1.3.0, in debian bookworm, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute

✨ SIAD(1) — the siad manual, bestie edition ✨

okay so. you opened the siad manual, and honestly? iconic decision. this is the page for the Sia Daemon, and i'm gonna walk you through every single flag like we're texting at 2am. no cap, nothing gets skipped. 💖

🌸 NAME 🌸

siad — the Sia Daemon. yeah that's it, that's the whole name, she's simple like that. 🎀

🦋 SYNOPSIS 🦋

siad version
siad modules
siad [OPTIONS]

three moods. pick your fighter. ✨

💅 DESCRIPTION 💅

so the Sia daemon, siad, is a background process that does all of the heavy lifting for Sia. literally all of it. she's the main character and the whole ensemble at the same time. she downloads the blockchain, uploads files, manages redundancy, monitors hosts for uptime — and that's just, like, a few of the many tasks she performs. i'm not even listing them all, the manpage said "to name a few" and i respect that energy.

and here's the tea 🍵: the daemon is composed of modules, and each module provides a set of primary functions on the network. so she's not one girl, she's a whole friend group. 🫶

🔥 OPTIONS 🔥

every flag, every default, every single one. buckle up bestie.

  • --agent="Sia-Agent" — the required substring for the user agent. yeah, she has a name tag and you gotta respect it.
  • --api-addr="localhost:9980" — which host:port the API server listens on.
  • --authenticate-api[=false] — enable API password protection. defaults to false, so it's off unless you say otherwise.
  • --disable-api-security[=false] — allow siad to listen on a non-localhost address. DANGEROUS. i'm saying it in the manpage's own voice because they put it in all caps and they meant it. 💀
  • --host-addr=":9982" — which port the host listens on.
  • -M, --modules="cghrtw" — the big one. see below, she gets her own section. 👑
  • --no-bootstrap[=false] — disable bootstrapping on this run.
  • --profile[=false] — enable profiling.
  • --profile-directory="profiles" — location of the profiling directory.
  • --rpc-addr=":9981" — which port the gateway listens on.
  • -d, --sia-directory="" — location of the sia directory.

👑 The -M / --modules flag, aka the friend group selector 👑

Use the -M or --modules flag to only run specific modules. Modules are independent components of Sia. This flag should only be used by developers or people who want to reduce overhead from unused modules. Modules are specified by their first letter. If the -M or --modules flag is not specified the default modules are run.

The default modules are: gateway, consensus set, host, miner, renter, transaction pool, wallet.

This is equivalent to:

siad -M cghmrtw

Below is a list of all the modules available. 🌈

Gateway (g)

The gateway maintains a peer to peer connection to the network and enables other modules to perform RPC calls on peers. The gateway is required by all other modules. she's the group chat admin fr fr.

siad -M g

Consensus Set (c)

The consensus set manages everything related to consensus and keeps the blockchain in sync with the rest of the network. The consensus set requires the gateway.

siad -M gc

Transaction Pool (t)

The transaction pool manages unconfirmed transactions. The transaction pool requires the consensus set.

siad -M gct

Wallet (w)

The wallet stores and manages siacoins and siafunds. The wallet requires the consensus set and transaction pool.

siad -M gctw

Renter (r)

The renter manages the user's files on the network. The renter requires the consensus set, transaction pool, and wallet.

siad -M gctwr

Host (h)

The host provides storage from local disks to the network. The host negotiates file contracts with remote renters to earn money for storing other users' files. The host requires the consensus set, transaction pool, and wallet. she's literally running a business. 💰

siad -M gctwh

Miner (m)

The miner provides a basic CPU mining implementation as well as an API for external miners to use. The miner requires the consensus set, transaction pool, and wallet.

siad -M gctwm

Explorer (e)

The explorer provides statistics about the blockchain and can be queried for information about specific transactions or other objects on the blockchain. The explorer requires the consenus set. (that's how the manpage spells it, i'm not fixing it, i'm just reporting the vibes. 🫶)

siad -M gce

💜 SEE ALSO 💜

go read her sisters, they're all slaying too:

🌈 HISTORY 🌈

1-May-2017 — Auto generated by spf13/cobra. so she was born fully formed by a robot, and honestly? ate. 👑

ok that's the whole page. every flag, every module, every default, every example — nothing left behind, periodt. 💖

and that's a wrap bestie! this little page came from the siad Manual, and it was auto generated by spf13/cobra back in May 2017. so like, vintage but make it iconic. go run some modules, stay off non-localhost addresses unless you know what you're doing, and text me when it works. 🦋✨🎀

📦 where this page comes from