m1ngsama/automa
1
0
Fork 0
mirror of https://github.com/m1ngsama/automa.git synced 2025-12-24 10:51:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
13 commits 2 branches 0 tags 6.4 MiB
Shell 91.5%
Makefile 8.5%
Find a file
m1ngsama 2e55194f5c feat: add operational utilities for monitoring and backup 
Add healthcheck.sh for service status monitoring
- Check container health and port accessibility
- Support individual service or all-services check

Add backup.sh for data protection
- Backup service data and configurations
- List existing backups
- Cleanup old backups with retention policy

Unix philosophy: small sharp tools that do one thing well
2025-12-07 13:00:00 +08:00
bin feat: add operational utilities for monitoring and backup 2025-12-07 13:00:00 +08:00
minecraft upload org multi repository clone scripts 2025-11-14 11:08:39 +08:00
nextcloud feat(nextcloud): add local nextcloud docker compose setup 2025-11-18 16:47:11 +08:00
teamspeak feat: add TeamSpeak environment template 2025-12-05 11:45:00 +08:00
.gitignore chore: add project infrastructure files 2025-12-02 10:00:00 +08:00
LICENSE chore: add project infrastructure files 2025-12-02 10:00:00 +08:00
Makefile feat: add unified Makefile for service management 2025-12-06 16:20:00 +08:00
README.md docs: add comprehensive project README 2025-12-03 14:30:00 +08:00

README.md

Automa

A collection of self-hosted service automation tools following the Unix philosophy: do one thing well, be composable, and stay simple.

Philosophy

This project embraces Unix principles:

  • Modularity: Each service is self-contained
  • Simplicity: Minimal dependencies, clear configuration
  • Composability: Tools work together through standard interfaces
  • Transparency: Plain text configuration, readable scripts

Services

Minecraft Server

Automated Minecraft Fabric server deployment with mod management.

Location: minecraft/ Quick Start:

cd minecraft
cp .env.example .env  # Edit as needed
docker compose up -d

See minecraft/README.md for details.

TeamSpeak Server

Voice communication server with minimal configuration.

Location: teamspeak/ Quick Start:

cd teamspeak
cp .env.example .env  # Edit as needed
docker compose up -d

See teamspeak/README.md for details.

Nextcloud

Self-hosted file sync and collaboration platform.

Location: nextcloud/ Quick Start:

cd nextcloud
cp .env.example .env  # Edit as needed
docker compose up -d

See nextcloud/README.md for details.

Utilities

Organization Repository Cloner

Batch clone all repositories from a GitHub organization.

Location: bin/org-clone.sh Usage:

./bin/org-clone.sh <org-name>

Prerequisites

  • Docker & Docker Compose
  • Bash 4.0+
  • Git

Project Structure

automa/
├── bin/                  # Utility scripts
│   └── org-clone.sh     # GitHub org repo cloner
├── minecraft/           # Minecraft server setup
├── teamspeak/           # TeamSpeak server setup
├── nextcloud/           # Nextcloud setup
└── README.md           # This file

Common Operations

All services follow consistent patterns:

Start a Service

cd <service-name>
docker compose up -d

View Logs

cd <service-name>
docker compose logs -f

Stop a Service

cd <service-name>
docker compose down

Update a Service

cd <service-name>
docker compose pull
docker compose up -d

Security Notes

  • Always change default passwords in .env files
  • Keep .env files out of version control
  • Use strong passwords for production deployments
  • Review exposed ports before deployment

Contributing

Contributions welcome. Keep changes:

  • Simple and focused
  • Well-documented
  • Following existing patterns
  • Unix philosophy aligned

License

MIT License - See LICENSE file for details.