mirror of
https://github.com/crocofied/CoreControl.git
synced 2025-12-29 16:14:43 +00:00
cleanup
This commit is contained in:
115
README.md
115
README.md
@@ -1,115 +0,0 @@
|
||||
|
||||

|
||||
|
||||
|
||||
# CoreControl
|
||||
|
||||
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.
|
||||
|
||||
[](https://www.buymeacoffee.com/corecontrol)
|
||||
[](https://github.com/sponsors/crocofied)
|
||||
|
||||
## Features
|
||||
|
||||
- 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.
|
||||
|
||||
## Screenshots
|
||||
Login Page:
|
||||

|
||||
|
||||
Dashboard Page:
|
||||

|
||||
|
||||
Servers Page:
|
||||

|
||||
|
||||
Server Detail Page
|
||||

|
||||
|
||||
Applications Page:
|
||||

|
||||
|
||||
Uptime Page:
|
||||

|
||||
|
||||
Network Page:
|
||||

|
||||
|
||||
Settings Page:
|
||||

|
||||
|
||||
## Roadmap
|
||||
- [X] Edit Applications, Applications searchbar
|
||||
- [X] Uptime History
|
||||
- [X] Notifications
|
||||
- [X] Simple Server Monitoring
|
||||
- [ ] Improved Network Flowchart with custom elements (like Network switches)
|
||||
- [ ] Advanced Settings (Disable Uptime Tracking & more)
|
||||
|
||||
## Deployment
|
||||
|
||||
Simply run this compose.yml:
|
||||
```yml
|
||||
services:
|
||||
web:
|
||||
image: haedlessdev/corecontrol:latest
|
||||
ports:
|
||||
- "3000:3000"
|
||||
environment:
|
||||
JWT_SECRET: RANDOM_SECRET # Replace with a secure random string
|
||||
DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres"
|
||||
|
||||
agent:
|
||||
image: haedlessdev/corecontrol-agent:latest
|
||||
environment:
|
||||
DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres"
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
|
||||
db:
|
||||
image: postgres:17
|
||||
restart: always
|
||||
environment:
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASSWORD: postgres
|
||||
POSTGRES_DB: postgres
|
||||
volumes:
|
||||
- postgres_data:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U postgres"]
|
||||
interval: 2s
|
||||
timeout: 2s
|
||||
retries: 10
|
||||
|
||||
volumes:
|
||||
postgres_data:
|
||||
```
|
||||
|
||||
#### Default Login
|
||||
__E-Mail:__ admin@example.com\
|
||||
__Password:__ admin
|
||||
|
||||
## Tech Stack & Credits
|
||||
|
||||
The application is build with:
|
||||
- Next.js & Typescript
|
||||
- Go (used 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/)
|
||||
- Application icons by [selfh.st/icons](https://selfh.st/icons)
|
||||
- Monitoring Tool by [Glances](https://github.com/nicolargo/glances)
|
||||
- and a lot of love ❤️
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://www.star-history.com/#crocofied/CoreControl&Date)
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the [MIT License](https://github.com/crocofied/CoreControl/blob/main/LICENSE).
|
||||
Reference in New Issue
Block a user