root
24 lines
1.1 KiB
Markdown
24 lines
1.1 KiB
Markdown
# TrueNAS Deploy
|
|
|
|
Composite Gitea Action that deploys a Docker Compose stack to TrueNAS SCALE over SSH (`/mnt/jupiter/apps/<owner>/<repo>`) and pulls the latest container images.
|
|
|
|
## Inputs
|
|
|
|
| Name | Required | Default | Description |
|
|
| :--- | :---: | :---: | :--- |
|
|
| `ssh_key` | Yes | - | Private SSH key for authenticating to TrueNAS (`secrets.TRUENAS_SSH_KEY`) |
|
|
| `app_name` | No | `${{ github.repository }}` | Application subpath under `/mnt/jupiter/apps/<owner>/<repo>` (defaults to `<owner>/<repo>`) |
|
|
| `compose_file` | No | `docker-compose.yaml` | Path to the local compose file (`docker-compose.yaml` or `docker-compose.yml` auto-detected) |
|
|
| `host` | No | `10.0.0.218` | TrueNAS SSH host IP or domain |
|
|
| `user` | No | `root` | TrueNAS SSH user |
|
|
| `env_file_content` | No | `""` | Optional `.env` file content to write to `/mnt/jupiter/apps/<owner>/<repo>/.env` (`0600`) |
|
|
|
|
## Example Usage
|
|
|
|
```yaml
|
|
- name: Deploy to TrueNAS
|
|
uses: https://git.rodydavis.dev/rodydavis/shared-actions/truenas-deploy@main
|
|
with:
|
|
ssh_key: ${{ secrets.TRUENAS_SSH_KEY }}
|
|
```
|