new simpler setup method, readme and doc update

src/common/args.go

@@ -13,6 +13,7 @@ type Args struct {
 
 const (
 	CommandStart              = ""
+	CommandSetup              = "setup"
 	CommandValidate           = "validate"
 	CommandListConfigs        = "ls-config"
 	CommandListRoutes         = "ls-routes"
@@ -23,6 +24,7 @@ const (
 
 var ValidCommands = []string{
 	CommandStart,
+	CommandSetup,
 	CommandValidate,
 	CommandListConfigs,
 	CommandListRoutes,

src/common/constants.go

@@ -10,29 +10,24 @@ const (
 	KeepAlive         = 5 * time.Second
 )
 
-const (
-	ProviderKind_Docker = "docker"
-	ProviderKind_File   = "file"
-)
-
 // file, folder structure
 
 const (
-	ConfigBasePath = "config/"
-	ConfigFileName = "config.yml"
-	ConfigPath     = ConfigBasePath + ConfigFileName
+	ConfigBasePath        = "config"
+	ConfigFileName        = "config.yml"
+	ConfigExampleFileName = "config.example.yml"
+	ConfigPath            = ConfigBasePath + "/" + ConfigFileName
 )
 
 const (
-	TemplatesBasePath        = "templates/"
-	PanelTemplatePath        = TemplatesBasePath + "panel/index.html"
-	ConfigEditorTemplatePath = TemplatesBasePath + "config_editor/index.html"
+	SchemaBasePath         = "schema"
+	ConfigSchemaPath       = SchemaBasePath + "/config.schema.json"
+	FileProviderSchemaPath = SchemaBasePath + "/providers.schema.json"
 )
 
 const (
-	SchemaBasePath         = "schema/"
-	ConfigSchemaPath       = SchemaBasePath + "config.schema.json"
-	FileProviderSchemaPath = SchemaBasePath + "providers.schema.json"
+	ComposeFileName        = "compose.yml"
+	ComposeExampleFileName = "compose.example.yml"
 )
 
 const DockerHostFromEnv = "$DOCKER_HOST"

src/common/env.go

@@ -7,18 +7,18 @@ import (
 )
 
 var (
-	NoSchemaValidation = getEnvBool("GOPROXY_NO_SCHEMA_VALIDATION")
-	IsDebug            = getEnvBool("GOPROXY_DEBUG")
-	ProxyHTTPAddr      = getEnv("GOPROXY_HTTP_ADDR", ":80")
-	ProxyHTTPSAddr     = getEnv("GOPROXY_HTTPS_ADDR", ":443")
-	APIHTTPAddr        = getEnv("GOPROXY_API_ADDR", "127.0.0.1:8888")
+	NoSchemaValidation = GetEnvBool("GOPROXY_NO_SCHEMA_VALIDATION")
+	IsDebug            = GetEnvBool("GOPROXY_DEBUG")
+	ProxyHTTPAddr      = GetEnv("GOPROXY_HTTP_ADDR", ":80")
+	ProxyHTTPSAddr     = GetEnv("GOPROXY_HTTPS_ADDR", ":443")
+	APIHTTPAddr        = GetEnv("GOPROXY_API_ADDR", "127.0.0.1:8888")
 )
 
-func getEnvBool(key string) bool {
+func GetEnvBool(key string) bool {
 	return U.ParseBool(os.Getenv(key))
 }
 
-func getEnv(key string, defaultValue string) string {
+func GetEnv(key string, defaultValue string) string {
 	value, ok := os.LookupEnv(key)
 	if !ok {
 		value = defaultValue

src/main.go

@@ -30,6 +30,12 @@ import (
 
 func main() {
 	args := common.GetArgs()
+
+	if args.Command == common.CommandSetup {
+		Setup()
+		return
+	}
+
 	l := logrus.WithField("module", "main")
 	onShutdown := F.NewSlice[func()]()
 

src/setup.go

@@ -0,0 +1,115 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"log"
+	"net/http"
+	"net/url"
+	"os"
+	"path"
+
+	. "github.com/yusing/go-proxy/common"
+)
+
+var branch = GetEnv("GOPROXY_BRANCH", "v0.5")
+var baseUrl = fmt.Sprintf("https://github.com/yusing/go-proxy/raw/%s", branch)
+var requiredConfigs = []Config{
+	{ConfigBasePath, true, false, ""},
+	{ComposeFileName, false, true, ComposeExampleFileName},
+	{path.Join(ConfigBasePath, ConfigFileName), false, true, ConfigExampleFileName},
+}
+
+type Config struct {
+	Pathname         string
+	IsDir            bool
+	NeedDownload     bool
+	DownloadFileName string
+}
+
+func Setup() {
+	log.Println("setting up go-proxy")
+	log.Println("branch:", branch)
+
+	os.Chdir("/setup")
+
+	for _, config := range requiredConfigs {
+		config.setup()
+	}
+
+	log.Println("done")
+}
+
+func (c *Config) setup() {
+	if c.IsDir {
+		mkdir(c.Pathname)
+		return
+	}
+	if !c.NeedDownload {
+		touch(c.Pathname)
+		return
+	}
+
+	fetch(c.DownloadFileName, c.Pathname)
+}
+
+func hasFileOrDir(path string) bool {
+	_, err := os.Stat(path)
+	return err == nil
+}
+
+func mkdir(pathname string) {
+	_, err := os.Stat(pathname)
+	if err != nil && os.IsNotExist(err) {
+		log.Printf("creating directory %q\n", pathname)
+		err := os.MkdirAll(pathname, 0o755)
+		if err != nil {
+			log.Fatalf("failed: %s\n", err)
+		}
+		return
+	}
+	if err != nil {
+		log.Fatalf("failed: %s\n", err)
+	}
+}
+
+func touch(pathname string) {
+	if hasFileOrDir(pathname) {
+		return
+	}
+	log.Printf("creating file %q\n", pathname)
+	_, err := os.Create(pathname)
+	if err != nil {
+		log.Fatalf("failed: %s\n", err)
+	}
+}
+func fetch(remoteFilename string, outFileName string) {
+	if hasFileOrDir(outFileName) {
+		return
+	}
+	log.Printf("downloading %q\n", remoteFilename)
+
+	url, err := url.JoinPath(baseUrl, remoteFilename)
+	if err != nil {
+		log.Fatalf("unexpected error: %s\n", err)
+	}
+
+	resp, err := http.Get(url)
+	if err != nil {
+		log.Fatalf("http request failed: %s\n", err)
+	}
+
+	defer resp.Body.Close()
+
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		log.Fatalf("error reading response body: %s\n", err)
+	}
+
+	err = os.WriteFile(outFileName, body, 0o644)
+	if err != nil {
+		log.Fatalf("failed to write to file: %s\n", err)
+	}
+
+	log.Printf("downloaded %q\n", outFileName)
+}