Categorygithub.com/dyrector-io/dyrectoriogolangpkgcli
package
0.0.0-20241003104419-c592368fdc93
Repository: https://github.com/dyrector-io/dyrectorio.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
41
Dependents
1
Files
1.5k SLOC

# README

dyrector.io platform: cli

We are working on the source code documentation, until then please use the root README.md for further information or check our official documentation site.

# Functions

CheckSettings makes sure your state is correct.
CopyTraefikConfiguration copies a config file to Traefik Container.
DisabledServiceSettings modifies the setting if the crux-ui is disabled.
No description provided by the author
EnsureNetworkExists makes sure the container network exists.
GetCrux services: db migrations and crux api service.
GetCruxPostgres returns crux's Postgres services' containers.
GetCruxUI returns a configured crux-ui service.
No description provided by the author
GetKratos returns Kratos services' containers.
GetKratosPostgres returns crux's Postgres services' containers.
GetMailSlurper returns the mailslurper service's container.
GetTraefik returns a traefik services container.
InitCLI returns the configuration flags of the program nolint:funlen.
LoadDefaultsOnEmpty There are options which are not filled out by default, we need to initialize values.
No description provided by the author
NotifyOnce makes sure user only gets some information only once.
PrintInfo tells the user not to use in prod and prints postgres information if crux is disabled.
PrintWelcomeMessage prints a welcome mesage before the command runs.
ProcessCommand is the main control function.
SaveSettings saves the settings.
SettingsExists is a check if the settings file is exists.
SettingsFileDefaults creating, reading and parsing the settings.yaml.
SettingsFileLocation is assembling the location of the settings file.
SettingsPath returns the full path to the settingsfile.
StartContainers is for creating and starting containers.
StopContainers is a cleanup for "down" command, prefix can be provided with for multi removal.

# Constants

CLIDirName is the directory where we save the configuration file under the users configuration directory.
commands.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
flags.
No description provided by the author
SettingsFileName is the filename we use for storing configuration.
commands.
commands.

# Structs

ArgsFlags are commandline arguments.
Containers contain container/service specific settings.
ContainerSettings are container specific settings.
Options are "globals" for the SettingsFile struct.
SettingsFile will be read/written as this struct.
State itself exists per-execution, settingsFile is persisted freedesktop spec folders used by default, $XDG_CONFIG_HOME.