sia: finish documentation #4514

Also rename stuttering `--sia-sia-user-agent` to `--sia-user-agent`
This commit is contained in:
Ivan Andreev
2021-10-10 15:24:23 +03:00
parent c5bc857f9b
commit 6d02530f9d
6 changed files with 132 additions and 70 deletions

View File

@@ -40,18 +40,20 @@ func init() {
Description: "Sia Decentralized Cloud",
NewFs: NewFs,
Options: []fs.Option{{
Name: "api_url",
Help: "Sia HTTP API URL\nLike http://127.0.0.1:9980",
Required: true,
Name: "api_url",
Help: `Sia daemon API URL, like http://sia.daemon.host:9980.
Note that siad must run with --disable-api-security to open API port for other hosts (not recommended).
Keep default if Sia daemon runs on localhost.`,
Default: "http://127.0.0.1:9980",
}, {
Name: "api_password",
Help: "Sia API Password\nsiad API Password",
Required: false,
Name: "api_password",
Help: `Sia Daemon API Password.
Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.`,
IsPassword: true,
}, {
Name: "sia_user_agent",
Help: "Siad User Agent\nSia requires a 'Sia-Agent' user agent by default for security",
Required: false,
Name: "user_agent",
Help: `Siad User Agent
Sia daemon requires the 'Sia-Agent' user agent by default for security`,
Default: "Sia-Agent",
Advanced: true,
}, {
@@ -73,7 +75,7 @@ func init() {
type Options struct {
APIURL string `config:"api_url"`
APIPassword string `config:"api_password"`
UserAgent string `config:"sia_user_agent"`
UserAgent string `config:"user_agent"`
Enc encoder.MultiEncoder `config:"encoding"`
}