* docs: add user guide, faq, and enhance troubleshooting - Created docs/user-guide.md with key concepts and workflows. - Created docs/faq.md with common questions and answers. - Enhanced docs/troubleshooting.md with AI/Agentic issues. - Updated README.md with CLI Quick Start and Getting Help sections. - Refactored mkdocs.yml to reflect actual file structure and include new docs. * docs: add user documentation and fix mkdocs navigation - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md with AI/Agentic issues. - Updated README.md with CLI Quick Start and Help links. - Restored original mkdocs.yml navigation and added new user documentation sections. - Fixed formatting in pkg/io/local/client.go to ensure CI passes. * docs: add user documentation and fix auto-merge workflow - Created docs/user-guide.md and docs/faq.md with user-focused content. - Enhanced docs/troubleshooting.md with AI/Agentic issue solutions. - Updated README.md with CLI Quick Start and organized help links. - Refactored mkdocs.yml to include new documentation while preserving technical sections. - Fixed .github/workflows/auto-merge.yml by inlining the logic and adding git repository context (checkout and -R flag) to resolve CI failures. - Verified that docs/workflows.md is present in the repository. * docs: add user documentation and resolve merge conflict - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md with AI/Agentic issue solutions. - Updated README.md with CLI Quick Start and Help sections. - Merged latest base branch changes and resolved conflict in .github/workflows/auto-merge.yml. - Verified and organized mkdocs.yml navigation. * docs: add user documentation and fix UniFi security issue - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md. - Updated README.md with CLI Quick Start. - Fixed UniFi security vulnerability (CodeQL alert) by making TLS verification configurable. - Added --insecure flag to UniFi CLI commands. - Verified all documentation links and navigation. * docs: add user documentation and fix formatting/security - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md. - Updated README.md with CLI Quick Start. - Fixed UniFi security vulnerability by making TLS verification configurable. - Added --insecure flag to UniFi CLI commands. - Fixed formatting in internal/cmd/unifi/cmd_config.go. - Verified all documentation links and navigation. --------- Co-authored-by: Claude <developers@lethean.io>
147 lines
3.9 KiB
Go
147 lines
3.9 KiB
Go
package unifi
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/host-uk/core/pkg/cli"
|
|
uf "github.com/host-uk/core/pkg/unifi"
|
|
)
|
|
|
|
// Config command flags.
|
|
var (
|
|
configURL string
|
|
configUser string
|
|
configPass string
|
|
configAPIKey string
|
|
configInsecure bool
|
|
configTest bool
|
|
)
|
|
|
|
// addConfigCommand adds the 'config' subcommand for UniFi connection setup.
|
|
func addConfigCommand(parent *cli.Command) {
|
|
cmd := &cli.Command{
|
|
Use: "config",
|
|
Short: "Configure UniFi connection",
|
|
Long: "Set the UniFi controller URL and credentials, or test the current connection.",
|
|
RunE: func(cmd *cli.Command, args []string) error {
|
|
return runConfig(cmd)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().StringVar(&configURL, "url", "", "UniFi controller URL")
|
|
cmd.Flags().StringVar(&configUser, "user", "", "UniFi username")
|
|
cmd.Flags().StringVar(&configPass, "pass", "", "UniFi password")
|
|
cmd.Flags().StringVar(&configAPIKey, "apikey", "", "UniFi API key")
|
|
cmd.Flags().BoolVar(&configInsecure, "insecure", false, "Allow insecure TLS connections (e.g. self-signed certs)")
|
|
cmd.Flags().BoolVar(&configTest, "test", false, "Test the current connection")
|
|
|
|
parent.AddCommand(cmd)
|
|
}
|
|
|
|
func runConfig(cmd *cli.Command) error {
|
|
var insecure *bool
|
|
if cmd.Flags().Changed("insecure") {
|
|
insecure = &configInsecure
|
|
}
|
|
|
|
// If setting values, save them first
|
|
if configURL != "" || configUser != "" || configPass != "" || configAPIKey != "" || insecure != nil {
|
|
if err := uf.SaveConfig(configURL, configUser, configPass, configAPIKey, insecure); err != nil {
|
|
return err
|
|
}
|
|
|
|
if configURL != "" {
|
|
cli.Success(fmt.Sprintf("UniFi URL set to %s", configURL))
|
|
}
|
|
if configUser != "" {
|
|
cli.Success("UniFi username saved")
|
|
}
|
|
if configPass != "" {
|
|
cli.Success("UniFi password saved")
|
|
}
|
|
if configAPIKey != "" {
|
|
cli.Success("UniFi API key saved")
|
|
}
|
|
if insecure != nil {
|
|
cli.Success(fmt.Sprintf("UniFi insecure mode set to %v", *insecure))
|
|
}
|
|
}
|
|
|
|
// If testing, verify the connection
|
|
if configTest {
|
|
return runConfigTest(cmd)
|
|
}
|
|
|
|
// If no flags, show current config
|
|
if configURL == "" && configUser == "" && configPass == "" && configAPIKey == "" && !configTest {
|
|
return showConfig()
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func showConfig() error {
|
|
url, user, pass, apikey, insecure, err := uf.ResolveConfig("", "", "", "", nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cli.Blank()
|
|
cli.Print(" %s %s\n", dimStyle.Render("URL:"), valueStyle.Render(url))
|
|
|
|
if user != "" {
|
|
cli.Print(" %s %s\n", dimStyle.Render("User:"), valueStyle.Render(user))
|
|
} else {
|
|
cli.Print(" %s %s\n", dimStyle.Render("User:"), warningStyle.Render("not set"))
|
|
}
|
|
|
|
if pass != "" {
|
|
cli.Print(" %s %s\n", dimStyle.Render("Pass:"), valueStyle.Render("****"))
|
|
} else {
|
|
cli.Print(" %s %s\n", dimStyle.Render("Pass:"), warningStyle.Render("not set"))
|
|
}
|
|
|
|
if apikey != "" {
|
|
masked := apikey
|
|
if len(apikey) >= 8 {
|
|
masked = apikey[:4] + "..." + apikey[len(apikey)-4:]
|
|
}
|
|
cli.Print(" %s %s\n", dimStyle.Render("API Key:"), valueStyle.Render(masked))
|
|
} else {
|
|
cli.Print(" %s %s\n", dimStyle.Render("API Key:"), warningStyle.Render("not set"))
|
|
}
|
|
|
|
cli.Print(" %s %s\n", dimStyle.Render("Insecure:"), valueStyle.Render(fmt.Sprintf("%v", insecure)))
|
|
|
|
cli.Blank()
|
|
|
|
return nil
|
|
}
|
|
|
|
func runConfigTest(cmd *cli.Command) error {
|
|
var insecure *bool
|
|
if cmd.Flags().Changed("insecure") {
|
|
insecure = &configInsecure
|
|
}
|
|
|
|
client, err := uf.NewFromConfig(configURL, configUser, configPass, configAPIKey, insecure)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
sites, err := client.GetSites()
|
|
if err != nil {
|
|
cli.Error("Connection failed")
|
|
return cli.WrapVerb(err, "connect to", "UniFi controller")
|
|
}
|
|
|
|
cli.Blank()
|
|
cli.Success(fmt.Sprintf("Connected to %s", client.URL()))
|
|
cli.Print(" %s %s\n", dimStyle.Render("Sites:"), numberStyle.Render(fmt.Sprintf("%d", len(sites))))
|
|
for _, s := range sites {
|
|
cli.Print(" %s %s\n", valueStyle.Render(s.Name), dimStyle.Render(s.Desc))
|
|
}
|
|
cli.Blank()
|
|
|
|
return nil
|
|
}
|