setup

Documentation

Index

• Constants
• func Cmd() *cobra.Command
• func Setup(dir string, force bool, tplFile []byte, configFiles [][]byte) error

Constants

const (
	// SetupHelp contains the short help text for the command.
	SetupHelp = "Creates the required files for using Docker Compose or Docker Swarm"

	// SetupHelpExtra contains the long help text for the command without the headline.
	SetupHelpExtra = `` /* 214-byte string literal not displayed */

	// SecretsDirName is the name of the directory for Docker Secrets.
	SecretsDirName = "secrets"

	// SuperadminFileName is the name of the secrets file containing the superadmin password.
	SuperadminFileName = "superadmin"

	// DefaultSuperadminPassword is the password for the first superadmin created with initial data.
	DefaultSuperadminPassword = "superadmin"

	// ManageAuthPasswordFileName is the name of the secrets file containing the password for
	// (basic) authorization to the manage service.
	ManageAuthPasswordFileName = "manage_auth_password"
)

Functions

func Cmd

func Cmd() *cobra.Command

Cmd returns the subcommand.

func Setup

func Setup(dir string, force bool, tplFile []byte, configFiles [][]byte) error

Setup creates YAML file for Docker Compose or Docker Swarm with secrets directory and directories for database and SSL certs volumes.

Existing files are skipped unless force is true. A custom template for the YAML file and YAML configs can be provided.