cli

Documentation

Index

• Constants
• Variables
• func BuildNewAnswer(buildDir, outputPath string, plugins []string, ...) (err error)
• func CheckConfigFile(configPath string) bool
• func CheckDBConnection(dataConf *data.Database) bool
• func CheckDBTableExist(dataConf *data.Database) bool
• func CheckUploadDir() bool
• func DumpAllData(dataConf *data.Database, dumpDataPath string) error
• func FormatAllPath(dataDirPath string)
• func GetConfigFilePath() string
• func InstallAllInitialEnvironment(dataDirPath string)
• func InstallConfigFile(configFilePath string) error
• func InstallI18nBundle(replace bool)
• func MergeI18nFilesLocal(originalI18nDir, targetI18nDir string) (err error)
• func ReplaceI18nFilesLocal(i18nDir string) error
• func SetDefaultConfig(dbConf *data.Database, cacheConf *data.CacheConf, field *ConfigField) error
• type ConfigField
• type OriginalAnswerInfo
• type YamlPluginContent

Constants

const (
	DefaultConfigFileName                  = "config.yaml"
	DefaultCacheFileName                   = "cache.db"
	DefaultReservedUsernamesConfigFileName = "reserved-usernames.json"
)

Variables

var (
	ConfigFileDir  = "/conf/"
	UploadFilePath = "/uploads/"
	I18nPath       = "/i18n/"
	CacheDir       = "/cache/"
)

Functions

func BuildNewAnswer

func BuildNewAnswer(buildDir, outputPath string, plugins []string, originalAnswerInfo OriginalAnswerInfo) (err error)

BuildNewAnswer builds a new answer with specified plugins

func CheckConfigFile

func CheckConfigFile(configPath string) bool

func CheckDBConnection

func CheckDBConnection(dataConf *data.Database) bool

CheckDBConnection check database whether the connection is normal

func CheckDBTableExist

func CheckDBTableExist(dataConf *data.Database) bool

CheckDBTableExist check database whether the table is already exists

func CheckUploadDir

func CheckUploadDir() bool

func DumpAllData

func DumpAllData(dataConf *data.Database, dumpDataPath string) error

DumpAllData dump all database data to sql

func FormatAllPath

func FormatAllPath(dataDirPath string)

func GetConfigFilePath

func GetConfigFilePath() string

GetConfigFilePath get config file path

func InstallAllInitialEnvironment

func InstallAllInitialEnvironment(dataDirPath string)

InstallAllInitialEnvironment install all initial environment

func InstallConfigFile

func InstallConfigFile(configFilePath string) error

func InstallI18nBundle

func InstallI18nBundle(replace bool)

func MergeI18nFilesLocal

func MergeI18nFilesLocal(originalI18nDir, targetI18nDir string) (err error)

MergeI18nFilesLocal merge i18n files

func ReplaceI18nFilesLocal

func ReplaceI18nFilesLocal(i18nDir string) error

ReplaceI18nFilesLocal replace i18n files

func SetDefaultConfig

func SetDefaultConfig(dbConf *data.Database, cacheConf *data.CacheConf, field *ConfigField) error

SetDefaultConfig set default config

Types

type ConfigField

type ConfigField struct {
	AllowPasswordLogin bool `json:"allow_password_login"`
	// The slug name of plugin that you want to deactivate
	DeactivatePluginSlugName string `json:"deactivate_plugin_slug_name"`
}

type OriginalAnswerInfo

type OriginalAnswerInfo struct {
	Version  string
	Revision string
	Time     string
}

type YamlPluginContent

type YamlPluginContent struct {
	Plugin map[string]any `yaml:"plugin"`
}