canasta

package

v1.19.0 Latest Latest Go to latest Published: Apr 19, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/CanastaWiki/Canasta-CLI-Go

Links

Open Source Insights

Documentation ¶

Index ¶

func CheckCanastaId(instance config.Installation) (config.Installation, error)
func CloneStackRepo(orchestrator, canastaId string, path *string) error
func CopyDatabase(databasePath, path, pwd string) error
func CopyEnv(envPath, path, pwd, rootDBpass string) error
func CopyLocalSettings(localSettingsPath, path, pwd string) error
func CopySetting(path, name string) error
func CopySettings(path string) error
func CopyYaml(yamlPath, path string) error
func DeleteConfigAndContainers(keepConfig bool, installationDir, orchestrator string)
func GetEnvVariable(envPath string) map[string]string
func GetOrGenerateAndSavePassword(pwd, path, prompt, filename string) (string, error)
func GetPasswordFromFile(path, filename string) (string, error)
func MigrateToNewVersion(path string) error
func RemoveImages(path, name string) error
func RemoveSettings(path, name string) error
func RewriteCaddy(path string) error
func RewriteSettings(path string, WikiNames []string) error
func SanityChecks(databasePath, localSettingsPath string) error
func SaveEnvVariable(envPath, key, value string) error
type CanastaVariables
- func GeneratePasswords(path string, canastaInfo CanastaVariables) (CanastaVariables, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckCanastaId ¶

func CheckCanastaId(instance config.Installation) (config.Installation, error)

Checking Installation existence

func CloneStackRepo ¶

func CloneStackRepo(orchestrator, canastaId string, path *string) error

CloneStackRepo() accepts the orchestrator from the CLI, passes the corresponding repository link, and clones the repo to a new folder in the specified path.

func CopyDatabase ¶

func CopyDatabase(databasePath, path, pwd string) error

Copies database dump from databasePath to the /_initdb/ at the installation directory

func CopyEnv ¶

func CopyEnv(envPath, path, pwd, rootDBpass string) error

if envPath is passed as argument, copies the file located at envPath to the installation directory else copies .env.example to .env in the installation directory

func CopyLocalSettings ¶

func CopyLocalSettings(localSettingsPath, path, pwd string) error

Copies the LocalSettings.php at localSettingsPath to /config at the installation directory

func CopySetting ¶ added in v1.11.0

func CopySetting(path, name string) error

func CopySettings ¶ added in v1.11.0

func CopySettings(path string) error

func CopyYaml ¶ added in v1.11.0

func CopyYaml(yamlPath, path string) error

func DeleteConfigAndContainers ¶ added in v1.2.0

func DeleteConfigAndContainers(keepConfig bool, installationDir, orchestrator string)

func GetEnvVariable ¶

func GetEnvVariable(envPath string) map[string]string

Get values saved inside the .env at the envPath

func GetOrGenerateAndSavePassword ¶ added in v1.12.0

func GetOrGenerateAndSavePassword(pwd, path, prompt, filename string) (string, error)

func GetPasswordFromFile ¶ added in v1.12.0

func GetPasswordFromFile(path, filename string) (string, error)

func MigrateToNewVersion ¶ added in v1.11.0

func MigrateToNewVersion(path string) error

func RemoveImages ¶ added in v1.11.0

func RemoveImages(path, name string) error

func RemoveSettings ¶ added in v1.11.0

func RemoveSettings(path, name string) error

func RewriteCaddy ¶ added in v1.11.0

func RewriteCaddy(path string) error

func RewriteSettings ¶ added in v1.11.0

func RewriteSettings(path string, WikiNames []string) error

func SanityChecks ¶

func SanityChecks(databasePath, localSettingsPath string) error

Verifying file extension for database dump

func SaveEnvVariable ¶

func SaveEnvVariable(envPath, key, value string) error

Make changes to the .env file at the installation directory

Types ¶

type CanastaVariables ¶

type CanastaVariables struct {
	Id             string
	AdminPassword  string
	AdminName      string
	RootDBPassword string
	WikiDBUsername string
	WikiDBPassword string
}

func GeneratePasswords ¶ added in v1.12.0

func GeneratePasswords(path string, canastaInfo CanastaVariables) (CanastaVariables, error)

Source Files ¶

View all Source files

canasta.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL