neunerlei/Deploy Docker to Compose Host

Github action, designed to deploy built docker-images onto a prepared host server through SSH.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None

Inputs

namedescriptionrequireddefault
ssh-hostThe SSH host to deploy to.yes—
ssh-userThe SSH user to connect to on the host—deployment
ssh-portThe SSH port on the host to connect to—22
ssh-fingerprintThe Fingerprint of the SSH server should you not be able to connect to the host——
ssh-keyThe BASE64 encoded private key to use when connecting to the server——
ssh-use-cloudflaredIf set to true, the connection will be tunneled through cloudflared—false
docker-dirThe directory on the host machine where to put the project folder—/02_docker
login-scriptThe script to refresh the docker-login before deployment—/opt/docker-login.sh
project-envUseful for staging and prod variants on the same host—prod
project-nameThe name of the project folder to create below the docker-dir—${GITHUB_REPOSITORY}/${project-env}
additional-filesA comma separated list of files that should be transferred to the host server——
before-scriptA shell script to execute on the host machine before the deployment takes place——
before-login-scriptA shell script to execute on the host machine before the docker login takes place——
before-pull-scriptA shell script to execute on the host machine before the new image is pulled——
after-pull-scriptA shell script to execute on the host machine after the new image was pulled——
after-scriptA shell script to execute on the host machine after the deployment took place——
archive-nameName of the transfer archive—${GITHUB_SHA}.${GITHUB_RUN_ID}.zip
server-env-file(The absolute path to an .env file on the server which will be appended to the generated .env file——
docker-compose-optionsAdditional docker-compose arguments to use when booting the container——

Outputs

no outputs