automa/README.md
m1ngsama 1ef24b3be8 improve: best-practice configs for all projects, CLI UX overhaul
Compose improvements:
- forgejo: add healthcheck (/api/healthz), ROOT_URL + SSH_PORT env, LFS
- tailscale: drop redundant privileged (use cap_add only), use devices
  for /dev/net/tun, mount /lib/modules, reliable healthcheck (tailscale
  status), profiles for opt-in DERP, headscale comment in .env.example
- uptime-kuma: add built-in healthcheck (extra/healthcheck)
- filesuite: add healthchecks for both cloudreve and qbittorrent
- minecraft: add mc-health check (built into itzg image), simplify volumes
- teamspeak: add healthcheck via ServerQuery (nc localhost 10011)
- nextcloud: add healthchecks for all 3 services, depends_on with
  service_healthy conditions so startup order is correct

CLI improvements:
- Fix docker compose detection (was broken with space in arg)
- Use global array for project discovery (no word-splitting bugs)
- Empty selection no longer defaults to "all" (safety)
- Show .env.example comments as hints during interactive configure
- Required fields (empty default) loop until user provides a value
- Disable colors when stdout is not a terminal
- compose() wrapper auto-adds --env-file
- Deduplicate project_exists / project_dir helpers
2026-04-15 10:02:41 +08:00

51 lines
1.4 KiB
Markdown

# automa
Self-hosted Docker Compose project deployer. Interactive CLI for quick deployment.
## Quick start
```bash
curl -fsSL https://raw.githubusercontent.com/m1ngsama/automa/main/install.sh | bash
cd ~/automa
./automa deploy
```
## Usage
```bash
./automa deploy # interactive project selection
./automa deploy forgejo filesuite # deploy specific projects
./automa status # check all project status
./automa logs forgejo # follow logs
./automa stop forgejo # stop a project
./automa update nextcloud # pull latest images & recreate
./automa config tailscale # reconfigure .env
./automa list # list available projects
```
## Projects
| Project | Description |
|---------|-------------|
| `forgejo` | Self-hosted Git (Gitea fork) |
| `uptime-kuma` | Uptime monitoring dashboard |
| `tailscale` | Tailscale client + DERP relay server (profiles) |
| `filesuite` | Cloudreve cloud storage + qBittorrent |
| `minecraft` | Fabric Minecraft server |
| `teamspeak` | TeamSpeak voice server |
| `nextcloud` | Nextcloud with MariaDB + Redis |
## Structure
Each project is a self-contained directory:
```
project-name/
├── compose.yaml # Docker Compose definition
├── .env.example # Template — comments shown during setup
└── .env # Your config (gitignored, created by CLI)
```
## License
MIT