{"id":34706693,"url":"https://github.com/m1ngsama/automa","last_synced_at":"2026-05-27T10:01:57.287Z","repository":{"id":322066766,"uuid":"1084690285","full_name":"m1ngsama/automa","owner":"m1ngsama","description":"Self-hosted Docker Compose deployer — interactive CLI to deploy Forgejo, Nextcloud, Minecraft, and more in seconds","archived":false,"fork":false,"pushed_at":"2026-04-15T03:02:56.000Z","size":7071,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-15T04:19:35.203Z","etag":null,"topics":["bash","cli","deployment","devops","docker","docker-compose","homelab","self-hosted"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m1ngsama.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-28T02:58:04.000Z","updated_at":"2026-04-15T03:02:53.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/m1ngsama/automa","commit_stats":null,"previous_names":["m1ngsama/automa"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/m1ngsama/automa","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1ngsama%2Fautoma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1ngsama%2Fautoma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1ngsama%2Fautoma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1ngsama%2Fautoma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m1ngsama","download_url":"https://codeload.github.com/m1ngsama/automa/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1ngsama%2Fautoma/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33560727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","cli","deployment","devops","docker","docker-compose","homelab","self-hosted"],"created_at":"2025-12-24T23:28:05.449Z","updated_at":"2026-05-27T10:01:57.281Z","avatar_url":"https://github.com/m1ngsama.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/banner.svg\" alt=\"automa\" width=\"600\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eOne command to deploy your self-hosted stack.\u003c/b\u003e\u003cbr\u003e\n  \u003csub\u003eInteractive CLI for Docker Compose — guided setup, auto-generated secrets, zero YAML editing.\u003c/sub\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/m1ngsama/automa/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/m1ngsama/automa?style=flat-square\u0026color=green\" alt=\"Release\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/m1ngsama/automa/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/m1ngsama/automa?style=flat-square\" alt=\"License\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/m1ngsama/automa/commits/main\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/m1ngsama/automa?style=flat-square\" alt=\"Last commit\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/bash-%3E%3D4.0-4EAA25?style=flat-square\u0026logo=gnubash\u0026logoColor=white\" alt=\"Bash 4+\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/docker_compose-v2-2496ED?style=flat-square\u0026logo=docker\u0026logoColor=white\" alt=\"Docker Compose v2\"\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/demo.gif\" alt=\"automa demo\" width=\"700\"\u003e\n\u003c/p\u003e\n\n---\n\n## Quick Start\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/m1ngsama/automa/main/install.sh | bash\ncd ~/automa\n./automa deploy\n```\n\nThat's it. The installer checks prerequisites, clones the repo, and you're ready to deploy.\n\n## Features\n\n- **Interactive CLI** — select projects from a numbered menu, guided `.env` setup with hints\n- **Zero config** — sensible defaults for every project, passwords and secrets auto-generated\n- **Non-interactive mode** — `automa -y deploy` accepts all defaults for CI/scripts\n- **Self-contained projects** — each is an independent directory, no shared dependencies\n- **Production-ready** — health checks, security hardening, least-privilege containers\n- **Extensible** — drop in a `compose.yaml` + `.env.example` and automa discovers it\n\n## Bundled Projects\n\n| Project | Description | Default Port | Upstream |\n|---------|-------------|:------------:|----------|\n| **Forgejo** | Self-hosted Git service (Gitea fork) | `3000` | [forgejo.org](https://forgejo.org) |\n| **Nextcloud** | Private cloud with MariaDB + Redis | `8080` | [nextcloud.com](https://nextcloud.com) |\n| **Uptime Kuma** | Uptime monitoring dashboard | `3001` | [GitHub](https://github.com/louislam/uptime-kuma) |\n| **Tailscale** | Mesh VPN client + optional DERP relay | host | [tailscale.com](https://tailscale.com) |\n| **Filesuite** | Cloudreve cloud storage + qBittorrent | `5212` `8090` | [cloudreve.org](https://cloudreve.org) |\n| **Minecraft** | Fabric server (itzg/minecraft-server) | `25565` | [Docs](https://docker-minecraft-server.readthedocs.io) |\n| **TeamSpeak** | Voice communication server | `9987/udp` | [teamspeak.com](https://teamspeak.com) |\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eProject-specific notes\u003c/b\u003e\u003c/summary\u003e\n\n#### Tailscale\n\nUses Docker Compose profiles — deploy only the VPN client or include the DERP relay:\n\n```bash\n# Tailscale client only\ndocker compose --profile tailscale up -d\n\n# Client + DERP relay\ndocker compose --profile derp up -d\n```\n\n#### Nextcloud\n\nShips with MariaDB 11 and Redis 7 as backing services. All three containers have health checks with `depends_on` ordering. First startup takes ~60s for database migration.\n\n#### Minecraft\n\nUses the [itzg/minecraft-server](https://docker-minecraft-server.readthedocs.io) image with Fabric mod loader. Mods go in `minecraft/data/mods/`. First startup takes ~2 minutes to download server files.\n\n\u003c/details\u003e\n\n## Usage\n\n```bash\nautoma deploy                       # interactive project selection\nautoma deploy forgejo nextcloud     # deploy specific projects\nautoma -y deploy forgejo            # non-interactive (CI/scripts)\nautoma status                       # overview dashboard\nautoma logs minecraft               # follow container logs\nautoma stop forgejo                 # stop a project\nautoma restart nextcloud            # restart a project\nautoma update nextcloud             # pull latest images \u0026 recreate\nautoma config tailscale             # reconfigure .env\nautoma list                         # list all projects\n```\n\n## How It Works\n\n```\n~/automa/\n├── automa                 # CLI entry point (single bash script)\n├── install.sh             # curl-pipe-bash installer\n├── forgejo/\n│   ├── compose.yaml       # Docker Compose definition\n│   ├── .env.example       # Template with @metadata + defaults\n│   └── .env               # Your config (gitignored, created by CLI)\n├── nextcloud/\n│   └── ...\n└── ...\n```\n\nEach `.env.example` carries metadata that the CLI reads:\n\n```bash\n# @name Forgejo\n# @desc Self-hosted Git service (Gitea fork)\n# @url https://forgejo.org\n# @port FORGEJO_HTTP_PORT\n```\n\nThe CLI uses these annotations to show project names, descriptions, docs links, and access URLs — all without extra configuration files.\n\n## Requirements\n\n| Dependency | Minimum | Check |\n|------------|---------|-------|\n| Docker | 20.10+ | `docker --version` |\n| Docker Compose | v2 (plugin) | `docker compose version` |\n| Bash | 4.0+ | `bash --version` |\n| Git | any | `git --version` |\n\nThe installer verifies all prerequisites automatically.\n\n## Uninstall\n\n```bash\ncd ~/automa\n./automa stop \u003ceach-project\u003e    # stop running containers\ncd ~ \u0026\u0026 rm -rf ~/automa         # remove automa\n```\n\nData is stored in each project's `data/` directory. Back up before removing if needed.\n\n## Contributing\n\nContributions welcome! To add a new project:\n\n1. Create a directory with `compose.yaml` (include health checks)\n2. Add `.env.example` with metadata headers (`@name`, `@desc`, `@url`, `@port`)\n3. Open a pull request\n\nSee existing projects for reference.\n\n## License\n\n[MIT](LICENSE) \u0026copy; [m1ngsama](https://github.com/m1ngsama)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm1ngsama%2Fautoma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm1ngsama%2Fautoma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm1ngsama%2Fautoma/lists"}