mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2025-01-16 20:45:29 +00:00
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
|
# 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 can not 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.
|