github.com/alloyci/alloy-runner@v1.0.1-0.20180222164613-925503ccafd6/docs/executors/ssh.md (about)

     1  # SSH
     2  
     3  >**Note:**
     4  The SSH executor supports only scripts generated in Bash and the caching feature
     5  is currently not supported.
     6  
     7  This is a simple executor that allows you to execute builds on a remote machine
     8  by executing commands over SSH.
     9  
    10  ## Overview
    11  
    12  To use the SSH executor you need to specify `executor = "ssh"` under the
    13  [`[runners.ssh]`][runners-ssh] section. For example:
    14  
    15  ```toml
    16  [[runners]]
    17    executor = "ssh"
    18    [runners.ssh]
    19      host = "example.com"
    20      port = "22"
    21      user = "root"
    22      password = "password"
    23      identity_file = "/path/to/identity/file"
    24  ```
    25  
    26  You can use `password` or `identity_file` or both to authenticate against the
    27  server. AlloyCI Runner doesn't implicitly read `identity_file` from
    28  `/home/user/.ssh/id_(rsa|dsa|ecdsa)`. The `identity_file` needs to be
    29  explicitly specified.
    30  
    31  The project's source is checked out to:
    32  `~/builds/<short-token>/<concurrent-id>/<namespace>/<project-name>`.
    33  
    34  Where:
    35  
    36  - `<short-token>` is a shortened version of the Runner's token (first 8 letters)
    37  - `<concurrent-id>` is a unique number, identifying the local job ID on the
    38    particular Runner in context of the project
    39  - `<namespace>` is the namespace where the project is stored on AlloyCI
    40  - `<project-name>` is the name of the project as it is stored on AlloyCI
    41  
    42  To overwrite the `~/builds` directory, specify the `builds_dir` options under
    43  `[[runners]]` section in [`config.toml`][toml].
    44  
    45  If you want to upload job artifacts, install `alloy-runner` on the host you are
    46  connecting to via SSH.
    47  
    48  ## Security
    49  
    50  The SSH executor is susceptible to MITM attacks (man-in-the-middle), because of
    51  the missing `StrictHostKeyChecking` option. This will be fixed in one of the
    52  future releases.
    53  
    54  [runners-ssh]: ../configuration/advanced-configuration.md#the-runnersssh-section
    55  [toml]: ../configuration/advanced-configuration.md