diff --git a/docs/.gitbook/assets/image.png b/docs/.gitbook/assets/image.png new file mode 100644 index 0000000..336d5b4 Binary files /dev/null and b/docs/.gitbook/assets/image.png differ diff --git a/docs/README.md b/docs/README.md index 5c4b4d5..38d11e9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,27 @@ -# Page +--- +icon: gear +layout: + title: + visible: true + description: + visible: true + tableOfContents: + visible: true + outline: + visible: false + pagination: + visible: true +--- +# CoreControl + +
+ +CoreControl is 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 + +* 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. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 4439a14..a4b8846 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,3 +1,4 @@ # Table of contents -* [Page](README.md) +* [CoreControl](README.md) +* [Installation](installation.md) diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..9bd88e8 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,56 @@ +--- +icon: down +--- + +# Installation + +To install the application using Docker Compose, first, ensure that Docker and Docker Compose are installed on your system. + +You can then simply install and start the following Docker compose. Remember that you have to generate a JWT\_SECRET beforehand. + +```yaml +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" + depends_on: + - db + - agent + + agent: + image: haedlessdev/corecontrol-agent:latest + environment: + DATABASE_URL: "postgresql://postgres:postgres@db:5432/postgres" + + 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: +``` + +Now start the application: + +```sh +docker compose up -d +``` + + + +**The default login is:** + +E-Mail: [admin@example.com](mailto:admin@example.com)\ +Password: admin + +_Be sure to set your own password and customize the e-mail, otherwise this poses a security risk!_