30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
# gitea-action-git-crypt-ssh-deploy
|
|
|
|
This action decrypts a repository that has been encrypted with git-crypt, and then deploys a docker-compose-based project.
|
|
|
|
## Inputs
|
|
|
|
* `ssh_private_key` - Private SSH key. Please keep this secure!
|
|
* `git_crypt_key` - Base64 encoded git-crypt key, see below. Must also be kept secure!
|
|
* `ssh_host` - Remote host to ssh to, where the project will be deployed.
|
|
* `ssh_port` - SSH port for the remote host. Defaults to 22.
|
|
* `ssh_user` - Username to use when connecting to the remote host.
|
|
* `docker_compose_project` - Name of the docker compose project. This will be used as the prefix by docker.
|
|
* `docker_compose_filename` - The filename of the compose file. Defaults to docker-compose.yml
|
|
* `docker_compose_down` - if set to `true`, the action will execute `docker compose down`.
|
|
|
|
## Getting the git crypt key
|
|
The key can be extracted from an unlocked repository with the following command:
|
|
|
|
```
|
|
git-crypt export-key - | base64
|
|
```
|
|
|
|
## Acknowledgement
|
|
|
|
This action is a combination of these two existing github actions:
|
|
|
|
- https://github.com/sliteteam/github-action-git-crypt-unlock
|
|
- https://github.com/matiasnu/github-action-ssh-docker-compose
|
|
|