diff --git a/README.md b/README.md index 0dd82d3276e777046ad57c44cbd0db650553b66a..32d69b9d78be2c5c6d541f876fcf795e3365c7e0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ The original SSH executor can only be used for a single/static host described in the runner config. This is not as flexible as our use-case's needs. -# Usage of the executor +# Usage of the installed executor Edit your `.gitlab-ci.yml` to have a job something like this: ```yaml deploy: @@ -16,11 +16,18 @@ deploy: SSH_HOST: donald.sch.bme.hu # required SSH_USER: kszk-gitlab-deployer # default: kszk-gitlab-deployer SSH_PORT: 10122 # default: 22 + only: # run only on protected branches + - master + - dev # optional ``` -Add the ssh pubkey of the root@gitlab-runner-host (/root/.ssh/id_*.pub) to the remote machine (to some deploy user; /home/deployer-user/.ssh/authorized_keys). +Add the ssh pubkey of the root@gitlab-runner-host (/root/.ssh/id_*.pub) +to the remote machine (kszk-gitlab-deployer user; +/home/kszk-gitlab-deployer/.ssh/authorized_keys). -# Install the executor +Rrepo files will be copied under /home/kszk-gitlab-deployer/ + +# Installation of the executor ```sh cd /opt git clone git@git.sch.bme.hu:kszk/opensource/ssh-executor.git ssh-executor