CoreControl/README.md

97 lines
2.9 KiB
Markdown
Raw Normal View History

2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
![Logo](https://i.ibb.co/hwSZTJH/Kopie-von-Cash-Mate.png)
2025-04-11 12:27:44 +02:00
2025-04-13 21:31:54 +02:00
# CoreControl
2025-04-13 21:30:50 +02:00
The only dashboard you'll ever need to manage your entire server infrastructure. Keep all your server data organized in one central place, easily add your self-hosted applications with quick access links, and monitor their availability in real-time with built-in uptime tracking. Designed for simplicity and control, it gives you a clear overview of your entire self-hosted setup at a glance.
## Features
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
- Dashboard: A clear screen with all the important information about your servers (WIP)
- Servers: This allows you to add all your servers (including Hardware Information), with Quicklinks to their Management Panels
- Applications: Add all your self-hosted services to a clear list and track their up and down time
- Networks: Generate visually stunning network flowcharts with ease.
2025-04-11 12:27:44 +02:00
2025-04-13 21:45:16 +02:00
## Screenshots
Login Page:
![Login Page](https://i.ibb.co/QvvJvHxY/image.png)
Dashboard Page:
![Dashboard Page](https://i.ibb.co/G3FW5mVX/image.png)
Servers Page:
![Servers Page](https://i.ibb.co/v6Z79wJY/image.png)
Applications Page:
![Applications Page](https://i.ibb.co/zC1f6s9/image.png)
Network Page:
![Network Page](https://i.ibb.co/XkKYrGQX/image.png)
2025-04-13 21:30:50 +02:00
## Roadmap
2025-04-13 21:31:54 +02:00
- [ ] Edit Applications, Applications searchbar
- [ ] Customizable Dashboard
- [ ] Notifications
- [ ] Uptime History
- [ ] Simple Server Monitoring
- [ ] Improved Network Flowchart with custom elements (like Network switches)
- [ ] Advanced Settings (Disable Uptime Tracking & more)
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
## Deployment
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
Simply run this compose.yml:
```yml
services:
web:
image: haedlessdev/corecontrol:latest
ports:
- "3000:3000"
environment:
LOGIN_EMAIL: "mail@example.com"
LOGIN_PASSWORD: "SecretPassword"
JWT_SECRET: RANDOM_SECRET
ACCOUNT_SECRET: RANDOM_SECRET
DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres?sslmode=require&schema=public"
depends_on:
- db
- agent
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
agent:
image: haedlessdev/corecontrol-agent:latest
environment:
DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres?sslmode=require&schema=public"
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
db:
image: postgres:17
restart: always
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: postgres
volumes:
- postgres_data:/var/lib/postgresql/data
volumes:
postgres_data:
```
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
## Tech Stack & Credits
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
The application is build with:
- Next.js & Typescript
- Go (for the agent)
- Tailwindcss with [shadcn](shadcn.com)
- PostgreSQL with [Prisma ORM](https://www.prisma.io/)
- Icons by [Lucide](https://lucide.dev/)
- Flowcharts by [React Flow](https://reactflow.dev/)
- and a lot of love ❤️
2025-04-11 12:27:44 +02:00
2025-04-13 22:59:23 +02:00
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=crocofied/CoreControl&type=Date)](https://www.star-history.com/#crocofied/CoreControl&Date)
2025-04-13 21:30:50 +02:00
## License
2025-04-11 12:27:44 +02:00
2025-04-13 21:30:50 +02:00
Licensed under the [MIT License](https://github.com/crocofied/CoreControl/blob/main/LICENSE).