filebrowser/cmd/config.go

package cmd

import (
	"encoding/json"
	nerrors "errors"
	"fmt"
	"os"
	"strings"
	"text/tabwriter"

	"github.com/filebrowser/filebrowser/v2/auth"
	"github.com/filebrowser/filebrowser/v2/errors"
	"github.com/filebrowser/filebrowser/v2/settings"
	"github.com/spf13/cobra"
)

func init() {
	rootCmd.AddCommand(configCmd)
}

var configCmd = &cobra.Command{
	Use:   "config",
	Short: "Configuration management utility",
	Long:  `Configuration management utility.`,
	Args:  cobra.NoArgs,
	Run: func(cmd *cobra.Command, args []string) {
		cmd.Help()
		os.Exit(0)
	},
}

func addConfigFlags(cmd *cobra.Command) {
	addUserFlags(cmd)
	cmd.Flags().StringP("baseURL", "b", "/", "base url of this installation")
	cmd.Flags().BoolP("signup", "s", false, "allow users to signup")
	cmd.Flags().String("shell", "", "shell command to which other commands should be appended")

	cmd.Flags().StringP("address", "a", "127.0.0.1", "default address to listen to")
	cmd.Flags().StringP("log", "l", "stderr", "log output")
	cmd.Flags().IntP("port", "p", 0, "default port to listen to")
	cmd.Flags().String("tls.cert", "", "tls certificate path")
	cmd.Flags().String("tls.key", "", "tls key path")

	cmd.Flags().String("auth.method", string(auth.MethodJSONAuth), "authentication type")
	cmd.Flags().String("auth.header", "", "HTTP header for auth.method=proxy")

	cmd.Flags().String("recaptcha.host", "https://www.google.com", "use another host for ReCAPTCHA. recaptcha.net might be useful in China")
	cmd.Flags().String("recaptcha.key", "", "ReCaptcha site key")
	cmd.Flags().String("recaptcha.secret", "", "ReCaptcha secret")

	cmd.Flags().String("branding.name", "", "replace 'File Browser' by this name")
	cmd.Flags().String("branding.files", "", "path to directory with images and custom styles")
	cmd.Flags().Bool("branding.disableExternal", false, "disable external links such as GitHub links")
}

func getAuthentication(cmd *cobra.Command) (settings.AuthMethod, auth.Auther) {
	method := settings.AuthMethod(mustGetString(cmd, "auth.method"))

	var auther auth.Auther
	if method == auth.MethodProxyAuth {
		header := mustGetString(cmd, "auth.header")
		if header == "" {
			panic(nerrors.New("you must set the flag 'auth.header' for method 'proxy'"))
		}
		auther = &auth.ProxyAuth{Header: header}
	}

	if method == auth.MethodNoAuth {
		auther = &auth.NoAuth{}
	}

	if method == auth.MethodJSONAuth {
		jsonAuth := &auth.JSONAuth{}

		host := mustGetString(cmd, "recaptcha.host")
		key := mustGetString(cmd, "recaptcha.key")
		secret := mustGetString(cmd, "recaptcha.secret")

		if key != "" && secret != "" {
			jsonAuth.ReCaptcha = &auth.ReCaptcha{
				Host:   host,
				Key:    key,
				Secret: secret,
			}
		}

		auther = jsonAuth
	}

	if auther == nil {
		panic(errors.ErrInvalidAuthMethod)
	}

	return method, auther
}

func printSettings(s *settings.Settings, auther auth.Auther) {
	w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)

	fmt.Fprintf(w, "\nBase URL:\t%s\n", s.BaseURL)
	fmt.Fprintf(w, "Sign up:\t%t\n", s.Signup)
	fmt.Fprintf(w, "Auth method:\t%s\n", s.AuthMethod)
	fmt.Fprintf(w, "Shell:\t%s\t\n", strings.Join(s.Shell, " "))
	fmt.Fprintf(w, "Log:\t%s\t\n", s.Log)
	fmt.Fprintln(w, "\nServer:")
	fmt.Fprintf(w, "\tAddress:\t%s\n", s.Server.Address)
	fmt.Fprintf(w, "\tPort:\t%d\n", s.Server.Port)
	fmt.Fprintf(w, "\tTLS Cert:\t%s\n", s.Server.TLSCert)
	fmt.Fprintf(w, "\tTLS Key:\t%s\n", s.Server.TLSKey)
	fmt.Fprintln(w, "\nBranding:")
	fmt.Fprintf(w, "\tName:\t%s\n", s.Branding.Name)
	fmt.Fprintf(w, "\tFiles override:\t%s\n", s.Branding.Files)
	fmt.Fprintf(w, "\tDisable external links:\t%t\n", s.Branding.DisableExternal)
	fmt.Fprintln(w, "\nDefaults:")
	fmt.Fprintf(w, "\tScope:\t%s\n", s.Defaults.Scope)
	fmt.Fprintf(w, "\tLocale:\t%s\n", s.Defaults.Locale)
	fmt.Fprintf(w, "\tView mode:\t%s\n", s.Defaults.ViewMode)
	fmt.Fprintf(w, "\tCommands:\t%s\n", strings.Join(s.Defaults.Commands, " "))
	fmt.Fprintf(w, "\tSorting:\n")
	fmt.Fprintf(w, "\t\tBy:\t%s\n", s.Defaults.Sorting.By)
	fmt.Fprintf(w, "\t\tAsc:\t%t\n", s.Defaults.Sorting.Asc)
	fmt.Fprintf(w, "\tPermissions:\n")
	fmt.Fprintf(w, "\t\tAdmin:\t%t\n", s.Defaults.Perm.Admin)
	fmt.Fprintf(w, "\t\tExecute:\t%t\n", s.Defaults.Perm.Execute)
	fmt.Fprintf(w, "\t\tCreate:\t%t\n", s.Defaults.Perm.Create)
	fmt.Fprintf(w, "\t\tRename:\t%t\n", s.Defaults.Perm.Rename)
	fmt.Fprintf(w, "\t\tModify:\t%t\n", s.Defaults.Perm.Modify)
	fmt.Fprintf(w, "\t\tDelete:\t%t\n", s.Defaults.Perm.Delete)
	fmt.Fprintf(w, "\t\tShare:\t%t\n", s.Defaults.Perm.Share)
	fmt.Fprintf(w, "\t\tDownload:\t%t\n", s.Defaults.Perm.Download)
	w.Flush()

	b, err := json.MarshalIndent(auther, "", "  ")
	checkErr(err)
	fmt.Printf("\nAuther configuration (raw):\n\n%s\n\n", string(b))
}