{"id":26605856,"url":"https://github.com/sanda0/vps_pilot","last_synced_at":"2025-08-11T15:14:45.126Z","repository":{"id":282703989,"uuid":"921304336","full_name":"sanda0/vps_pilot","owner":"sanda0","description":"VPS Pilot is a server monitoring and management platform designed for private VPS servers. It provides real-time monitoring, alerting, project management, and (future) cron job automation — all from a single dashboard.","archived":false,"fork":false,"pushed_at":"2025-05-31T03:12:33.000Z","size":295,"stargazers_count":18,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-31T11:01:32.351Z","etag":null,"topics":["backup","cloud-management","golang","monitoring","postgresql","reactjs","s3","shadcn-ui","time-series","timescaledb"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/sanda0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":null},"created_at":"2025-01-23T17:56:08.000Z","updated_at":"2025-05-31T03:12:29.000Z","dependencies_parsed_at":"2025-04-05T17:19:03.894Z","dependency_job_id":"8ad99c61-893c-4d41-b3cd-dffcfe1647e3","html_url":"https://github.com/sanda0/vps_pilot","commit_stats":null,"previous_names":["sanda0/vps_pilot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sanda0/vps_pilot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanda0%2Fvps_pilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanda0%2Fvps_pilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanda0%2Fvps_pilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanda0%2Fvps_pilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanda0","download_url":"https://codeload.github.com/sanda0/vps_pilot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanda0%2Fvps_pilot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269909863,"owners_count":24494844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"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":["backup","cloud-management","golang","monitoring","postgresql","reactjs","s3","shadcn-ui","time-series","timescaledb"],"created_at":"2025-03-23T21:16:44.632Z","updated_at":"2025-08-11T15:14:45.108Z","avatar_url":"https://github.com/sanda0.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VPS Pilot\n\nVPS Pilot is a **server monitoring and management platform** designed for private VPS servers.  \nIt provides real-time monitoring, alerting, project management, and (future) cron job automation — all from a single dashboard.\n\n![Screenshot from 2025-04-29 08-13-30](https://github.com/user-attachments/assets/fff1c368-9c8e-4bb6-9720-f9a7f46a2910)\n\n\n\n## ✨ Features\n\n### 📊 Monitoring\n- Agents installed on each node (server). (Agent repo: https://github.com/sanda0/vps_pilot_agent)\n- Agents send system metrics to the central server:\n  - **CPU usage**\n  - **Memory usage**\n  - **Network statistics**\n- Metrics are visualized in the dashboard with selectable time ranges:\n  - 5 minutes, 15 minutes, 1 hour, 1 day, 2 days, 7 days.\n---\n\n### 🚨 Alerting\n- Users can configure alerts based on metric thresholds.\n- Notifications sent via:\n  - **Discord** (✅ Implemented)\n  - **Email** (✅ Implemented)\n  - **Slack** (✅ Implemented)\n\n---\n\n### 🚀 Projects Management (TODO)\n- Each node can have multiple projects.\n- Projects require a `config.vpspilot.json` file.\n- Agents scan disks for project config files and send project metadata to the central server.\n- Central server will display available projects and allow:\n  - Running predefined commands.\n  - Managing project logs.\n  - Backing up project directories and databases.\n\n**Sample `config.vpspilot.json`:**\n```json\n{\n  \"name\": \"meta ads dashboard\",\n  \"tech\": [\"laravel\", \"react\", \"mysql\"],\n  \"logs\": [],\n  \"commands\": [\n    { \"name\": \"node build\", \"command\": \"npm run build\" },\n    { \"name\": \"php build\", \"command\": \"composer install\" }\n  ],\n  \"backups\": {\n    \"env_file\": \".env\",\n    \"zip_file_name\": \"project_backup\",\n    \"database\": {\n      \"connection\": \"DB_CONNECTION\",\n      \"host\": \"DB_HOST\",\n      \"port\": \"DB_PORT\",\n      \"username\": \"DB_USERNAME\",\n      \"password\": \"DB_PASSWORD\",\n      \"database_name\": \"DB_DATABASE\"\n    },\n    \"dir\": [\n      \"storage/app\",\n      \"database/companies\"\n    ]\n  }\n}\n```\n\u003e **Note:** This feature is still under development.\n\n---\n\n### ⏲️ Cron Jobs Management (TODO)\n- Plan to allow users to create and manage cron jobs on nodes remotely from the dashboard.\n- Feature is not implemented yet.\n\n---\n\n## 🛠️ Tech Stack\n\n| Component        | Technology |\n|------------------|------------|\n| Agent            | Golang     |\n| Central Server   | Golang     |\n| Dashboard        | React.js   |\n| Database         | TimescaleDB |\n\n---\n\n## ⚙️ Configuration\n\n### Email Alerts\nConfigure the following environment variables in your `.env` file for email notifications:\n\n```env\nMAIL_HOST=\"your-smtp-host.com\"\nMAIL_PORT=465\nMAIL_USERNAME=\"your-email@domain.com\"\nMAIL_PASSWORD=\"your-email-password\"\nMAIL_FROM_ADDRESS=\"noreply@domain.com\"\n```\n\n### Slack Alerts\nFor Slack notifications, configure webhook URLs per alert in the dashboard. To create a Slack webhook:\n1. Go to your Slack workspace\n2. Navigate to Apps → Incoming Webhooks\n3. Create a new webhook for your desired channel\n4. Copy the webhook URL and paste it in the alert configuration\n\n### Discord Alerts\nFor Discord notifications, configure webhook URLs per alert in the dashboard. To create a Discord webhook:\n1. Go to your Discord server settings\n2. Navigate to Integrations → Webhooks\n3. Create a new webhook for your desired channel\n4. Copy the webhook URL and paste it in the alert configuration\n\n---\n\n## 📦 Installation\n\n(Instructions will be added soon. Likely via Docker Compose or manual Go/React build.)\n\n---\n\n## 📅 Roadmap\n\n- [x] Real-time metrics collection (CPU, Memory, Network)\n- [x] Discord alert integration\n- [x] Email alert integration\n- [x] Slack alert integration\n- [ ] Project management via `config.vpspilot.json`\n- [ ] Remote command execution for projects\n- [ ] Project backups (database + directories)\n- [ ] Remote cron job creation and management\n\n---\n\n## 🧑‍💻 Author\n\nMade with ❤️ by [Sandakelum](https://github.com/sanda0)\n\n---\n\n## 📜 License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanda0%2Fvps_pilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanda0%2Fvps_pilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanda0%2Fvps_pilot/lists"}