woodpecker/docs/versioned_docs/version-1.0/30-administration/22-backends/30-ssh.md
Robert Kaussow 7756c60a33
Enable golangci linter stylecheck (#3167)
This PR only fixes error string formatting, log message strings are
still mixed upper/lowercase (see
https://github.com/woodpecker-ci/woodpecker/pull/3161#issuecomment-1885140649)
and I'm not aware of a linter to enforce it.
2024-01-10 22:56:42 +01:00

1.3 KiB

SSH backend

:::danger The SSH backend will execute the pipelines using SSH on a remote system without any isolation of any kind. :::

:::note This backend is still pretty new and cannot be treated as stable. Its implementation and configuration can change at any time. ::: Since the code run directly on the SSH machine, a malicious pipeline could access and edit files the SSH user has access to and execute every command the remote user is allowed to use. Always restrict the user as far as possible!

It is recommended to use this backend only for private setups where the code and pipelines can be trusted. You shouldn't use it for a public facing CI where anyone can submit code or add new repositories.

The backend will use a random directory in $TMPDIR to store the clone code and execute commands.

Configuration

WOODPECKER_BACKEND_SSH_ADDRESS

Default: empty

The SSH host to run steps with ssh backend.

WOODPECKER_BACKEND_SSH_USER

Default: empty

The SSH user to run steps with ssh backend.

WOODPECKER_BACKEND_SSH_KEY

Default: empty

Path to the private SSH key to run steps with ssh backend.

WOODPECKER_BACKEND_SSH_KEY_PASSWORD

Default: empty

The password for the private key to run steps with ssh backend.

WOODPECKER_BACKEND_SSH_PASSWORD

Default empty

The SSH password to run steps with ssh backend.