Documentation
¶
Index ¶
- Variables
- func ApplyFlags(cfg *config.Config, f *FlagValues)
- func ApplyNodeState(cfg *config.Config, dataDir string, explicitFlags map[string]bool)
- func CtrlDo(socketPath string, cmd interface{}) (map[string]json.RawMessage, error)
- func DecodeJoinCode(code string) (relay, token, network string, err error)
- func DoJoin(cfg *config.Config, relayAddr, token string) error
- func EncodeJoinCode(relay, token, network string) string
- func LoadOrInitCA(dir, token string) (*node.CA, error)
- func PrintUsage()
- func ResolveDataDir(dataDir string) string
- func RunACL(args []string)
- func RunBulk(args []string)
- func RunCA(args []string)
- func RunCASign(args []string)
- func RunCert(args []string)
- func RunCompletion(args []string)
- func RunConnect(args []string)
- func RunDNS(args []string)
- func RunEvents(args []string)
- func RunForward(args []string)
- func RunGroups(args []string)
- func RunID(args []string)
- func RunInvite(args []string)
- func RunJoin(args []string)
- func RunLogs(args []string)
- func RunMeshIP(args []string)
- func RunNode(args []string)
- func RunPin(args []string)
- func RunRemoteConfig(args []string)
- func RunRestart(args []string)
- func RunRevoke(args []string)
- func RunRoute(args []string)
- func RunSetName(args []string)
- func RunStart(args []string)
- func RunStats(args []string)
- func RunStatus(args []string)
- func RunStop(args []string)
- func RunTag(args []string)
- func RunTemplate(args []string)
- func RunToken(args []string)
- func RunTop(args []string)
- func RunUnpin(args []string)
- func RunUntag(args []string)
- func SocketPath(args []string) string
- type FlagValues
Constants ¶
This section is empty.
Variables ¶
var NodeVersion = "dev"
RunNode starts a relay node. Called when pulse is run with no subcommand. NodeVersion is set by main.go from ldflags.
Functions ¶
func ApplyFlags ¶
func ApplyFlags(cfg *config.Config, f *FlagValues)
ApplyFlags merges CLI flags into the loaded config. Flags take precedence.
func ApplyNodeState ¶ added in v0.2.0
ApplyNodeState loads state.dat and applies fields not explicitly set via CLI flags.
func CtrlDo ¶
func CtrlDo(socketPath string, cmd interface{}) (map[string]json.RawMessage, error)
CtrlDo sends a JSON command to the daemon's control socket and returns the response.
func DecodeJoinCode ¶ added in v0.2.0
DecodeJoinCode decodes a pls_ join code into relay, token, network.
func EncodeJoinCode ¶ added in v0.2.0
EncodeJoinCode encodes relay address, token, and network ID into a single string. Format: pls_<base64(json)>
func LoadOrInitCA ¶
LoadOrInitCA loads or creates a CA from the given directory.
func PrintUsage ¶
func PrintUsage()
func ResolveDataDir ¶
ResolveDataDir resolves the data directory from flags or defaults.
func RunCompletion ¶ added in v0.2.0
func RunCompletion(args []string)
func RunConnect ¶
func RunConnect(args []string)
func RunForward ¶
func RunForward(args []string)
func RunRemoteConfig ¶ added in v0.2.2
func RunRemoteConfig(args []string)
func RunRestart ¶ added in v0.2.0
func RunRestart(args []string)
func RunSetName ¶
func RunSetName(args []string)
func RunTemplate ¶ added in v0.2.0
func RunTemplate(args []string)
func SocketPath ¶
SocketPath resolves the control socket path from flags or defaults.
Types ¶
type FlagValues ¶ added in v0.2.2
type FlagValues struct {
Addr string
Listen string
TCP string
DataDir string
NetworkID string
JoinAddr string
JoinToken string
CAEnabled bool
CAToken string
SOCKSEnabled bool
SOCKSListen string
DNSEnabled bool
DNSListen string
TunEnabled bool
TunQueues int
FECEnabled bool
ScribeEnabled bool
ScribeListen string
ExitEnabled bool
ExitCIDRs string
MeshCIDR string
}
FlagValues holds all the CLI flag values for running a node.
func NodeFlags ¶
func NodeFlags(fs *flag.FlagSet) *FlagValues
NodeFlags registers all flags for running a node on the given FlagSet.
Source Files