autoconfigcmd

type EnvFormat string

type EnvMapping struct {
	// Key is the SKYENV variable name (e.g. "ISHYPERVISOR").
	Key string
	// Format is the wire encoding for KEY=… in /etc/skywire.conf.
	Format EnvFormat
	// Negate inverts the emit for bool flags. A negation flag like
	// --no-ishv has Negate=true so passing it (which sets the
	// bool to true) writes ISHYPERVISOR=false to the .conf file.
	Negate bool
	// Default is the effective default the visor's `cli config gen`
	// uses when the SKYENV variable is unset/commented. Empty when
	// the underlying default is "" (no useful hint to show). This
	// field exists so the WASM install-page can display the actual
	// default as a placeholder hint — operators see "default:
	// 127.0.0.1:8001" rather than the misleading "(unset)" the
	// flag's own DefValue reports (which is "" because autoconfig
	// itself defaults every flag to empty, deferring to skywire.conf
	// / config-gen for the real default).
	//
	// Source of truth: the `:-` fallbacks in
	// cmd/skywire-cli/commands/config/gen.go's scriptExec* calls,
	// plus the skyenv constants those calls reference for the
	// string-typed defaults. Keep in sync — if config-gen's
	// defaults change, update this table too.
	Default string
	// Note is operator-facing guidance that does not fit the flag's
	// own one-line description because it is about how this variable
	// interacts with ANOTHER one: a dependency ("pin TRANSPORTPORT
	// when you turn this on") or a conflict ("this and DMSGSERVERCONF
	// are mutually exclusive"). The install-page form renders it
	// beside the field; the CLI does not print it, since --help
	// already shows every flag at once and the cross-references read
	// as noise there.
	//
	// Empty for the vast majority of variables, which stand alone.
	Note string
}

type Flag struct {
	Name        string `json:"name"`
	Short       string `json:"short,omitempty"`
	Type        string `json:"type"` // "bool" | "string" | "int"
	DefaultVal  string `json:"default,omitempty"`
	Description string `json:"description"`

	// EnvKey is the variable this flag writes; empty for flags that only
	// affect one autoconfig run (--verbose, --no-restart).
	EnvKey string `json:"env_key,omitempty"`
	// EnvFormat is the .conf encoding: "bool", "string", "int", "bashArray".
	EnvFormat string `json:"env_format,omitempty"`
	// EnvNegate marks a --no-X flag, which writes KEY=false.
	EnvNegate bool `json:"env_negate,omitempty"`
	// EnvDefault is what config gen uses while the variable is unset.
	EnvDefault string `json:"env_default,omitempty"`
	// EnvNote is guidance about how this variable interacts with another.
	EnvNote string `json:"env_note,omitempty"`
}

type Values struct {
	// --- Display-only ---
	Verbose bool

	// --- Hypervisor / identity ---
	Hvpks        string
	WSPeers      string // WSPEERS: <pk>@<ws(s)://…> peers held as WebSocket transports
	Ishv         bool
	NoIshv       bool
	HvDeskAddr   string // HVDESKADDR
	PkEndpoint   bool   // ENABLEPKENDPOINT
	NoPkEndpoint bool
	HvAuth       bool // HVAUTH
	NoHvAuth     bool
	HvAddr       string // HVHTTPADDR
	SecretKey    string // SK — security-sensitive; see flag description
	Version      string // VERSION — testing override

	// --- Visor public/private + autoconnect ---
	RewardAddr     string
	Public         bool
	NoPublic       bool
	PublicIP       bool // DISPLAYNODEIP
	DisablePubAuto bool

	// --- Service discovery / deployment ---
	TestEnv     bool   // TESTENV
	URL         string // SVCCONFADDR (services conf URL — accepts comma-list)
	SvcConf     string // SVCCONF (fallback service-configuration file)
	MinSess     int    // MINDMSGSESS
	StunServers string // STUNSERVERS (comma-separated)

	// --- Public-visor transport limit ---
	MaxTransports int // MAXTRANSPORTS (pause service-discovery registration at this DISTINCT-PEER count)

	// --- Transport ports ---
	StcprPort      int
	SudphPort      int
	TransportPort  int
	LanDmsgPort    int
	LanDmsgPublic  string
	DmsgServerConf string
	// DmsgServer runs a dmsg server inside the visor on the visor's OWN key,
	// sharing its transport port — writes DMSGSERVER. NoDmsgServer turns it
	// back off, the way every other boolean here is unset.
	DmsgServer   bool
	NoDmsgServer bool
	// DmsgServerPublic is the address that server advertises — writes
	// DMSGSERVERPUBLIC.
	DmsgServerPublic string

	// DmsgServerWSTLS is where that server self-terminates TLS for its wss
	// front (":443") instead of leaving it to a reverse proxy on the host —
	// writes DMSGSERVERWSTLS. Which is right differs per host: some already
	// run Caddy on :443, and on the rest the standalone dmsg server WAS the
	// terminator, so folding it left the advertised wss front with nothing
	// listening behind it.
	DmsgServerWSTLS string

	// DmsgRelayAddr is a loopback host:port for the local dmsg relay acceptor —
	// writes DMSGRELAYADDR. The unix socket is served by default and needs no
	// config, but it carries the VISOR's uid at 0600, so a service running as a
	// different user cannot open it. A loopback acceptor has no such problem;
	// its gate is DmsgRelayKeys instead of file permissions.
	DmsgRelayAddr string
	// DmsgRelayKeys are the public keys allowed to attach, comma-separated —
	// writes DMSGRELAYKEYS. Required with DmsgRelayAddr.
	DmsgRelayKeys string
	// NoDmsgRelay turns the acceptor off entirely — writes NODMSGRELAY.
	NoDmsgRelay bool

	// --- Privacy / routing knobs ---
	MinHops            int  // MINHOPS (>=2 forces multihop for sender privacy)
	ARTransportLimit   int  // ARTRANSPORTLIMIT (address-resolver registration policy)
	NoDirectTransports bool // NODIRECTTRANSPORTS (never create direct p2p transports)
	PtyRPCExec         bool // PTYRPCEXEC (allow visor-RPC-initiated dmsgpty exec)

	// --- Whitelists ---
	DmsgptyPks     string
	SurveyPks      string // SURVEYPKS
	RouteSetupPKs  string // ROUTESETUPPKS
	TransportSetup string // TPSETUPPKS

	// --- Route calculation ---
	CalculateRoutes bool // CALCULATEROUTES

	// --- VPN server feature ---
	VpnServer           bool
	NoVpnServer         bool
	VpnRouter           bool   // VPNROUTER
	VpnRouterLanIfc     string // VPNROUTERLANIFC
	VpnRouterSubnet     string // VPNROUTERSUBNET
	VpnRouterWifi       bool   // VPNROUTERWIFI
	VpnRouterSSID       string // VPNROUTERSSID
	VpnRouterPassphrase string // VPNROUTERPASSPHRASE
	VpnRouterBand       string // VPNROUTERBAND
	VpnRouterChannel    int    // VPNROUTERCHANNEL
	VpnRouterCountry    string // VPNROUTERCOUNTRY
	VpnRouterOpenWiFi   bool   // VPNROUTEROPEN
	VpnRouterMeshGW     bool   // VPNROUTERMESHGW
	VpnRouterMeshGWCIDR string // VPNROUTERMESHGWCIDR
	VpnRouterMeshTLS    bool   // VPNROUTERMESHTLS
	VpnKillSw           string // VPNKS
	AddVpn              string // ADDVPNPK
	VpnWl               string // VPNSERVERWL (comma-separated)
	VpnSecure           string // VPNSEVERSECURE (sic — typo retained for compat with config gen's env-var name)
	VpnNetIfc           string // VPNSEVERNETIFC (sic — same)

	// --- Proxy feature ---
	ProxyServer   bool
	NoProxyServer bool
	ProxyClientPK string // PROXYCLIENTPK
	StartProxyCli bool   // STARTPROXYCLIENT
	ProxyWl       string // PROXYSERVERWL (comma-separated)

	// --- SOCKS5 web bridges ---
	Dmsgweb           bool
	NoDmsgweb         bool
	Skynetweb         bool
	NoSkynetweb       bool
	DmsgwebUpstream   string // DMSGWEBUPSTREAM
	SkynetwebUpstream string // SKYNETWEBUPSTREAM
	DmsgwebAddr       string // DMSGWEBADDR
	// DmsgwebSK runs the embedded resolver under this secret key instead of the
	// visor's — writes DMSGWEBSK. For a key the deployment already knows and
	// cannot rotate, such as a survey whitelist.
	DmsgwebSK     string // DMSGWEBSK
	SkynetwebAddr string // SKYNETWEBADDR
	// Resolvers (RESOLVERS) declares ADDITIONAL resolving proxies beyond
	// the DMSGWEB/SKYNETWEB pair, one comma-separated spec each. See the
	// flag's help text for the spec grammar.
	Resolvers string

	// --- Embedded Wisp server ---
	//
	// The backend a browser-side Linux guest asks to open its connections.
	// Every browser-tab visor runs it and no native one does, so there is
	// nothing to turn on; only its egress is a setting. It lives in the conf
	// because a wasm visor regenerates its config on every load, so a
	// hand-edited wisp section does not survive.
	WispSOCKS string // WISPSOCKS

	// --- Skychat ---
	Skychat         bool
	NoSkychat       bool
	ChatAddr        string // SKYCHATADDR
	ChatPortless    bool   // SKYCHATPORTLESS — no TCP port, hypervisor-only
	NoChatPortless  bool
	ServeChatPair   bool // SKYCHATPAIR — default true in config gen
	NoServeChatPair bool

	// --- Skymail bridge (SMTP↔skywire) ---
	SkymailBridge   bool // SKYMAILBRIDGE
	NoSkymailBridge bool

	// --- Skycoin daemon (legacy + multi-instance) ---
	Skycoind          bool
	NoSkycoind        bool
	SkycoindFiber     string // SKYCOIND_FIBER_TOML
	SkycoindAPI       string // SKYCOIND_API_SETS
	SkycoindUser      string // SKYCOIND_USER
	SkycoindInstances string // SKYCOIND_INSTANCES (comma-separated)
	SkycoindFlags     string // SKYCOIND_FLAGS

	// --- Skycoin web wallet ---
	Skycoinweb         bool
	NoSkycoinweb       bool
	SkycoinwebAddr     string // SKYCOINWEBADDR
	SkycoinwebNodes    string // SKYCOINWEBNODES (comma-separated)
	SkycoinwebWallet   string // SKYCOINWEBWALLET
	SkycoinwebElectrum string // SKYCOINWEBELECTRUM
	SkycoinwebUser     string // SKYCOINWEBUSER

	// --- Visor runtime ---
	BinPath         string // BINPATH
	LogLevel        string // LOGLVL
	ShutdownTimeout string // SHUTDOWNTIMEOUT
	RegTimeout      string // REGTIMEOUT

	// --- Runtime behavior (NOT written to skywire.conf) ---
	// NoRestart generates/writes the config but skips the
	// systemctl restart of skywire.service at the end. This is the
	// pty-safe update path: when the operator is connected over the
	// visor's own dmsgpty, restarting skywire.service kills that pty
	// session (and any in-flight apt/autoconfig process with it). With
	// --no-restart the config is applied without the restart; the
	// operator then triggers the restart out-of-band as the LAST step
	// via `systemctl start --no-block skywire-autoconfig.service`,
	// which runs decoupled from the session.
	NoRestart bool
}