24 lines
1.0 KiB
Markdown
24 lines
1.0 KiB
Markdown
# Deploy to TrueNAS (`truenas-deploy`)
|
|
|
|
Deploys a Docker Compose stack directly to TrueNAS SCALE (`/mnt/jupiter/apps/<app_name>`) over SSH and runs `docker compose pull && docker compose up -d --remove-orphans`.
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- name: Deploy to TrueNAS
|
|
uses: https://git.rodydavis.dev/rodydavis/shared-actions/truenas-deploy@main
|
|
with:
|
|
ssh_key: ${{ secrets.TRUENAS_SSH_KEY }}
|
|
```
|
|
|
|
### Optional Inputs
|
|
|
|
| Input | Description | Default |
|
|
| :--- | :--- | :--- |
|
|
| `ssh_key` | **(Required)** Private SSH key for authenticating to TrueNAS (`secrets.TRUENAS_SSH_KEY`). | — |
|
|
| `app_name` | Application directory name under `/mnt/jupiter/apps/<app_name>`. | Repository name |
|
|
| `compose_file` | Local compose file path (auto-detects `docker-compose.yaml` or `docker-compose.yml`). | `docker-compose.yaml` |
|
|
| `host` | TrueNAS SSH host IP or hostname. | `10.0.0.218` |
|
|
| `user` | TrueNAS SSH user. | `root` |
|
|
| `env_file_content` | Optional `.env` file contents to write to `/mnt/jupiter/apps/<app_name>/.env`. | `''` |
|