remote

package

v1.1.3 Latest Latest Go to latest Published: Apr 27, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SomniSom/docker-ops

Links

Open Source Insights

Documentation ¶

Overview ¶

Package remote runs docker compose on a host over SSH (readme §4.5).

Index ¶

func RunDockerCompose(cfg *config.Config, tty bool, composeArgs ...string) error
func RunDockerComposeClient(client *ssh.Client, cfg *config.Config, composeFileOverride string, ...) error
func RunDockerComposeInteractive(cfg *config.Config, composeArgs ...string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RunDockerCompose ¶

func RunDockerCompose(cfg *config.Config, tty bool, composeArgs ...string) error

RunDockerCompose runs `docker compose` in cfg.RemotePath on the remote host.

func RunDockerComposeClient ¶

func RunDockerComposeClient(client *ssh.Client, cfg *config.Config, composeFileOverride string, tty, rawLocalStdin bool, composeArgs ...string) error

RunDockerComposeClient runs `docker compose` using an existing SSH client (same session as SFTP deploy). If composeFileOverride is non-empty, it is passed as -f instead of cfg.ComposeFile. rawLocalStdin should be true only for interactive exec (dq exec bash): Ctrl+D and signals behave correctly.

func RunDockerComposeInteractive ¶

func RunDockerComposeInteractive(cfg *config.Config, composeArgs ...string) error

RunDockerComposeInteractive runs docker compose over SSH for dq exec -it: raw local stdin + SIGINT forwarded to the server.

Types ¶

This section is empty.

Source Files ¶

View all Source files

compose.go

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