Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

dokkuclient

package

Go to main page

Versions in this module

v1

v1.0.24

Nov 17, 2024

v1.0.23

Nov 17, 2024

v1.0.22

Nov 2, 2024

v1.0.21

Nov 2, 2024

Changes in this version

type Client

+ func (c *Client) ProxyBuildConfig(ctx context.Context, appName string) error

v1.0.20

Nov 2, 2024

Changes in this version

type Client

+ func (c *Client) NginxConfigGetValue(ctx context.Context, appName string, property string) (string, error)

+ func (c *Client) NginxConfigResetValue(ctx context.Context, appName string, property string) error

+ func (c *Client) NginxConfigSetValue(ctx context.Context, appName string, property string, value string) error

v1.0.19

Sep 18, 2024

v1.0.18

Aug 31, 2024

v1.0.17

Aug 2, 2024

v1.0.16

Jun 28, 2024

v1.0.15

May 29, 2024

Changes in this version

+ var ErrInvalidUser = errors.New("must use a dokku user for authentication, see the docs")

+ func DoubleDashArg[T ValueString](key string, value T) string

+ type Client struct

+ func New(client *goph.Client, logSshCommands bool, uploadAppName string, ...) *Client

+ func (c *Client) AppCreate(ctx context.Context, appName string) error

+ func (c *Client) AppDestroy(ctx context.Context, appName string) error

+ func (c *Client) AppExists(ctx context.Context, appName string) (bool, error)

+ func (c *Client) ChecksGet(ctx context.Context, appName string) (status string, err error)

+ func (c *Client) ChecksSet(ctx context.Context, appName string, status string) error

+ func (c *Client) ConfigExport(ctx context.Context, appName string) (res map[string]string, err error)

+ func (c *Client) ConfigSet(ctx context.Context, appName string, data map[string]string) error

+ func (c *Client) ConfigUnset(ctx context.Context, appName string, names []string) error

+ func (c *Client) DeployFromArchive(ctx context.Context, appName string, archiveType string, archiveUrl string) error

+ func (c *Client) DeployFromImage(ctx context.Context, appName string, dockerImage string, allowRebuild bool) (deployed bool, err error)

+ func (c *Client) DeployRebuild(ctx context.Context, appName string) error

+ func (c *Client) DeploySyncRepository(ctx context.Context, appName string, repositoryUrl string, ref string) error

+ func (c *Client) DeployUnsetSourceImage(ctx context.Context, appName string) error

+ func (c *Client) DockerOptionAdd(ctx context.Context, appName string, phases []string, value string) error

+ func (c *Client) DockerOptionExists(ctx context.Context, appName string, phase string, value string) (bool, error)

+ func (c *Client) DockerOptionRemove(ctx context.Context, appName string, phases []string, value string) error

+ func (c *Client) DomainAdd(ctx context.Context, appName string, domain string) error

+ func (c *Client) DomainRemove(ctx context.Context, appName string, domain string) error

+ func (c *Client) DomainsClear(ctx context.Context, appName string) error

+ func (c *Client) DomainsDisable(ctx context.Context, appName string) error

+ func (c *Client) DomainsEnable(ctx context.Context, appName string) error

+ func (c *Client) DomainsExport(ctx context.Context, appName string) (res []string, err error)

+ func (c *Client) DomainsSet(ctx context.Context, appName string, domains []string) error

+ func (c *Client) GetVersion(ctx context.Context) (rawVersion string, parsedVersion semver.Version, err error)

+ func (c *Client) GitAuth(ctx context.Context, host string, login string, password string) error

+ func (c *Client) GlobalDomainAdd(ctx context.Context, domain string) error

+ func (c *Client) GlobalDomainExists(ctx context.Context, domain string) (bool, error)

+ func (c *Client) GlobalDomainRemove(ctx context.Context, domain string) error

+ func (c *Client) HttpAuthAddUser(ctx context.Context, appName string, user string, password string) error

+ func (c *Client) HttpAuthDisable(ctx context.Context, appName string) error

+ func (c *Client) HttpAuthEnable(ctx context.Context, appName string) error

+ func (c *Client) HttpAuthRemoveUser(ctx context.Context, appName string, user string) error

+ func (c *Client) HttpAuthReport(ctx context.Context, appName string) (enabled bool, users []string, err error)

+ func (c *Client) LetsencryptAddCronJob(ctx context.Context) error

+ func (c *Client) LetsencryptDisable(ctx context.Context, appName string) error

+ func (c *Client) LetsencryptEnable(ctx context.Context, appName string) error

+ func (c *Client) LetsencryptIsEnabled(ctx context.Context, appName string) (bool, error)

+ func (c *Client) LetsencryptSetEmail(ctx context.Context, appName string, email string) error

+ func (c *Client) NetworkCreate(ctx context.Context, name string) error

+ func (c *Client) NetworkEnsureAndSetForApp(ctx context.Context, appName string, networkType string, name string) error

+ func (c *Client) NetworkExists(ctx context.Context, name string) (bool, error)

+ func (c *Client) NetworkGetNameForApp(ctx context.Context, appName string, networkType string) (string, error)

+ func (c *Client) NetworkUnsetForApp(ctx context.Context, appName string, networkType string) error

+ func (c *Client) NetworksReport(ctx context.Context, name string) (networks map[string]string, err error)

+ func (c *Client) PluginIsInstalled(ctx context.Context, pluginNameToFind string) (bool, error)

+ func (c *Client) PortAdd(ctx context.Context, appName string, scheme string, hostPort int64, ...) error

+ func (c *Client) PortRemove(ctx context.Context, appName string, hostPort int64) error

+ func (c *Client) PortsClear(ctx context.Context, appName string) error

+ func (c *Client) PortsExport(ctx context.Context, appName string) (res []Port, err error)

+ func (c *Client) PortsSet(ctx context.Context, appName string, ports []Port) error

+ func (c *Client) ProcessRestart(ctx context.Context, appName string) error

+ func (c *Client) ProxyDisable(ctx context.Context, appName string) error

+ func (c *Client) ProxyEnable(ctx context.Context, appName string) error

+ func (c *Client) RegistryLogin(ctx context.Context, host string, login string, password string) error

+ func (c *Client) Run(ctx context.Context, cmd string, sensitiveStrings ...string) (stdout string, status int, err error)

+ func (c *Client) RunQuiet(ctx context.Context, cmd string, sensitiveStrings ...string) (stdout string, status int, err error)

+ func (c *Client) SimpleServiceCreate(ctx context.Context, servicePluginName string, serviceName string, ...) error

+ func (c *Client) SimpleServiceDestroy(ctx context.Context, servicePluginName string, serviceName string) error

+ func (c *Client) SimpleServiceExists(ctx context.Context, servicePluginName string, serviceName string) (bool, error)

+ func (c *Client) SimpleServiceExpose(ctx context.Context, servicePluginName string, serviceName string, ...) error

+ func (c *Client) SimpleServiceInfo(ctx context.Context, servicePluginName string, serviceName string) (map[string]string, error)

+ func (c *Client) SimpleServiceLinkCreate(ctx context.Context, servicePluginName string, serviceName string, ...) error

+ func (c *Client) SimpleServiceLinkExists(ctx context.Context, servicePluginName string, serviceName string, ...) (bool, error)

+ func (c *Client) SimpleServiceLinkRemove(ctx context.Context, servicePluginName string, serviceName string, ...) error

+ func (c *Client) SimpleServiceUnexpose(ctx context.Context, servicePluginName string, serviceName string) error

+ func (c *Client) StorageEnsure(ctx context.Context, name string, localDirectory *string) error

+ func (c *Client) StorageExport(ctx context.Context, appName string) (res map[string]string, err error)

+ func (c *Client) StorageMount(ctx context.Context, appName string, name string, mountPath string) error

+ func (c *Client) StorageUnmount(ctx context.Context, appName string, name string, mountPath string) error

+ type Port struct

+ ContainerPort string

+ HostPort string

+ Scheme string

+ type ValueString interface

+ ValueString func() string