Skip to content

Latest commit

 

History

History
153 lines (128 loc) · 4.69 KB

README.md

File metadata and controls

153 lines (128 loc) · 4.69 KB
Raw

Sia

GoDoc

A host for Sia.

Overview

hostd is an advanced Sia host solution created by the Sia Foundation, designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, hostd boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. hostd incorporates an embedded web-UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices.

Configuration

hostd can be configured in multiple ways. Some settings, like the wallet key, can be configured via environment variables or stdin. Others, like the RHP ports, can be configured via CLI flags. To simplify more complex configurations, hostd also supports the use of a YAML configuration file for all settings.

Default Ports

  • 9980 - UI and API
  • 9981 - Sia consensus
  • 9982 - RHP2
  • 9983 - RHP3

Environment Variables

  • HOSTD_API_PASSWORD - The password for the UI and API
  • HOSTD_SEED - The recovery phrase for the wallet
  • HOSTD_LOG_FILE - changes the location of the log file. If unset, the log file will be created in the data directory
  • HOSTD_CONFIG_FILE - changes the path of the optional config file. If unset, hostd will check for a config file in the current directory

CLI Flags

-dir string
	directory to store hostd metadata (default "/Users/n8maninger/Downloads/hostd-core-tmp")
-http string
	address to serve API on (default "localhost:9980")
-log.level string
	log level (debug, info, warn, error) (default "debug")
-name string
	a friendly name for the host, only used for display
-network string
	network name (mainnet, testnet, etc) (default "mainnet")
-openui
	automatically open the web UI on startup (default true)
-syncer.address string
	address to listen on for peer connections (default ":9981")
-syncer.bootstrap
	bootstrap the gateway and consensus modules (default true)
-rhp2 string
	address to listen on for RHP2 connections (default ":9982")
-rhp3 string
	address to listen on for TCP RHP3 connections (default ":9983")
-env
	disable stdin prompts for environment variables (default false)

YAML

All environment variables and CLI flags can be set via a YAML config file. The config file defaults to hostd.yml in the current directory, but can be changed with the HOSTD_CONFIG_FILE environment variable. All fields are optional and default to the same values as the CLI flags.

directory: /etc/hostd
recoveryPhrase: indicate nature buzz route rude embody engage confirm aspect potato weapon bid
http:
  address: :9980
  password: sia is cool
syncer:
  address: :9981
  bootstrap: true
consensus:
  network: mainnet
  indexBatchSize: 100
rhp2:
  address: :9982
rhp3:
  tcp: :9983
log:
  level: info # global log level
  stdout:
    enabled: true # enable logging to stdout
    level: info # log level for console logger
    format: human # log format (human, json)
    enableANSI: true # enable ANSI color codes (disabled on Windows)
  file:
    enabled: true # enable logging to file
    level: info # log level for file logger
    path: /var/log/hostd/hostd.log # the path of the log file
    format: json # log format (human, json)

Building

hostd uses SQLite for its persistence. A gcc toolchain is required to build hostd

go generate ./...
CGO_ENABLED=1 go build -o bin/ -tags='netgo timetzdata' -trimpath -a -ldflags '-s -w'  ./cmd/hostd

Docker

hostd includes a Dockerfile which can be used for building and running hostd within a docker container. The image can also be pulled from ghcr.io/siafoundation/hostd.

Be careful with port 9980 as Docker will expose it publicly by default. It is recommended to bind it to 127.0.0.1 to prevent unauthorized access.

Docker Compose

version: "3.9"
services:
  host:
    image: ghcr.io/siafoundation/hostd:latest
    ports:
      - 127.0.0.1:9980:9980/tcp
      - 9981-9983:9981-9983/tcp
    volumes:
      - /data:/data
      - /storage:/storage
    restart: unless-stopped

Docker Engine

docker run -d \
  --name hostd \
  -p 127.0.0.1:9980:9980 \
  -p 9981-9983:9981-9983 \
  -v ./data:/data \
  -v ./storage:/storage \
    ghcr.io/siafoundation/hostd:latest

Building Image

docker build -t hostd .