Updated Docs

docs/.vitepress/config.mts

@@ -32,7 +32,30 @@ export default defineConfig({
         items: [
           { text: 'Installation', link: '/installation' },
         ]
+      },
+      {
+        text: 'General',
+        items: [
+          { text: 'Dashboard', link: '/general/dashboard' },
+          { text: 'Servers', link: '/general/servers' },
+          { text: 'Applications', link: '/general/applications' },
+          { text: 'Uptime', link: '/general/uptime' },
+          { text: 'Network', link: '/general/network' },
+          { text: 'Settings', link: '/general/settings' },
+        ]
+      },
+      {
+        text: 'Notifications',
+        items: [
+          { text: 'Notifications', link: '/notifications/general' },
+          { text: 'Email', link: '/notifications/email' },
+          { text: 'Telegram', link: '/notifications/telegram' },
+          { text: 'Discord', link: '/notifications/discord' },
+          { text: 'Gotify', link: '/notifications/gotify' },
+          { text: 'Ntfy', link: '/notifications/ntfy' },
+        ]
       }
+      
     ],
 
     socialLinks: [

docs/general/Applications.md

@@ -0,0 +1,27 @@
+# Applications
+
+All your self-hosted applications are displayed here.
+
+## Add an application
+
+To add a new application to CoreControl, follow these steps:
+
+1. Click the "Add Application" button in the top right corner of the server menu:
+   ![Application Add Button](../assets/screenshots/applications_add_button.png)
+
+2. Fill out the server details across the following information:
+
+- **Name**: Enter the name of the application
+- **Server**: Select the server on which the application is running
+- **Description**: Enter a short (or long) description of the server
+- **Icon URL**: Add the url pointing to the logo of the application. With the flash button the logo will be automatically selected.
+- **Public URL**: Enter the public URL of your application. This will be used to track the uptime.
+- **Local URL**: Enter the local URL of your application, i.e. the URL via which the application is only accessible in the local network
+
+
+
+After filling out the required information, click "Add" to add the application to CoreControl.
+
+## Application Display
+Your applications are displayed in a list or grid (depending on the display settings) - each application in its own card
+![Application card](../assets/screenshots/applications_display.png)

docs/general/Dashboard.md

@@ -0,0 +1,31 @@
+# Dashboard
+
+The dashboard is the most important place to get a quick overview of your infrastructure.
+
+## Cards Overview
+The dashboard is divided into 4 cards that provide different aspects of your infrastructure monitoring:
+
+### Servers Card
+![Servers Card](../assets/screenshots/dashboard_card_servers.png)
+
+The Servers card displays information about all your connected servers, including:
+- Number of Physical Servers
+- Number of Virtual Servers
+
+### Applications Card
+![Applications Card](../assets/screenshots/dashboard_card_applications.png)
+
+The Applications card shows you:
+- Number of running applications across your infrastructure
+
+### Uptime Card
+![Uptime Card](../assets/screenshots/dashboard_card_uptime.png)
+
+The Uptime card provides:
+- Number of online applications
+
+### Network Card
+![Network Card](../assets/screenshots/dashboard_card_network.png)
+
+The Network card displays:
+- Sum of servers and applications

docs/general/Network.md

@@ -0,0 +1,3 @@
+# Network
+
+A network flowchart is automatically generated on this page, which shows the connections of your infrastructure. The main servers are displayed based on the main node “My Infrastrucutre”. Below this are the applications running directly on this server and next to it the VMs running on the server, if it is a host server. To the right of the VMs, all applications running on the respective VM are listed.

docs/general/Servers.md

@@ -0,0 +1,80 @@
+# Servers
+
+In the server menu you can see all your servers and add more if required
+
+## Add a Server
+To add a new server to CoreControl, follow these steps:
+
+1. Click the "Add Server" button in the top right corner of the server menu:
+   ![Servers Add Button](../assets/screenshots/servers_add_button.png)
+
+2. Fill out the server details across the following tabs:
+
+### General Tab
+Configure the basic server information:
+- **Icon**: Choose a custom icon for your server
+- **Name**: Enter a descriptive name for the server
+- **Operating System**: Select the server's operating system
+- **IP Address**: Enter the server's IP address
+- **Management URL**: Add the URL used to manage the server (optional)
+
+### Hardware Tab
+Specify the server's hardware specifications:
+- **CPU**: Enter CPU model and specifications
+- **GPU**: Add graphics card details if applicable
+- **RAM**: Specify the amount of RAM
+- **Disk**: Enter storage capacity and configuration
+
+### Virtualization Tab
+Configure virtualization settings:
+- **Host Server Settings**:
+  - Enable "Host Server" if this server will host virtual machines
+  - Perfect for hypervisors like Proxmox, VMware, or similar
+- **VM Settings**:
+  - Select a host server if this server is a virtual machine
+  - This creates a logical connection between the VM and its host
+
+### Monitoring Tab
+Set up server monitoring options (see "Monitoring" section for detailed information)
+
+After filling out the required information, click "Add" to add the server to CoreControl.
+
+## Monitoring
+
+If you want to monitor the hardware usage and status of your servers, you will have to enable monitoring in the monitoring tab.
+
+After you have done this you need to install [Glances](https://github.com/nicolargo/glances) on the server. To help you with this, we have created a sample compose that you can simply copy. For detailed customizations, please refer to the [Glances docs](https://glances.readthedocs.io/en/latest/).
+
+```yaml
+services:
+  glances:
+    image: nicolargo/glances:latest
+    container_name: glances
+    restart: unless-stopped
+    ports:
+      - "61208:61208"
+    pid: "host"
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    environment:
+      - GLANCES_OPT=-w --disable-webui
+```
+::: warning
+Please also make sure that CoreControl can reach the specified API URL of Glances. In addition, the Glances API URL should be specified in the format `http://<IP_OF_SERVER>:61208`.
+:::
+
+## Server Display
+Your servers are displayed in a list or grid (depending on the display settings) - each server in its own card
+![Server Card](../assets/screenshots/servers_display.png)
+
+There are also three action buttons at the end of each card.
+- Link Button - With this you can open the specified management URL of the server with one click
+- Delete Button - Direct deletion of the server
+- Edit Button - Customize the server with the same menu as when creating the server
+
+## VMs
+If a host server contains VMs, you can display them using the “VMs” button
+![VMs Button](../assets/screenshots/servers_vms_button.png)
+
+The associated VMs are then displayed in a clearly arranged list.
+![VM List](../assets/screenshots/servers_vms_list.png)

docs/general/Settings.md

@@ -0,0 +1,11 @@
+# Settings
+Here you can manage the complete settings of CoreControl.
+
+## User Settings
+![User Settings](../assets/screenshots/settings_user.png)
+
+## Theme Settings
+![Theme Settings](../assets/screenshots/settings_theme.png)
+
+## Notification Settings
+![Notification Settings](../assets/screenshots/settings_notifications.png)

docs/general/Uptime.md

@@ -0,0 +1,7 @@
+# Uptime
+
+The uptime of all your Applications is shown here in a clear list.
+
+![Uptime](../assets/screenshots/uptime.png)
+
+With the Select menu you can also filter the time span (30min, 7 days and 30 days)

docs/index.md

@@ -5,7 +5,6 @@ layout: home
 hero:
   name: "CoreControl"
   text: "Manage your server infrastructure"
-  tagline: My great project tagline
   actions:
     - theme: brand
       text: Install
@@ -18,12 +17,24 @@ hero:
     alt: Logo
 
 features:
-  - title: Feature A
+  - icon: 🚀
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+    title: Easy Deployment
-  - title: Feature B
+    details: Deploy and manage your servers with just a few clicks - thanks to docker
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - icon: 🔒
-  - title: Feature C
+    title: Secure Management
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+    details: Secure connections with the panel and a more secure authentication system
+  - icon: 📊
+    title: Real-time Monitoring
+    details: Monitor server performance, resource usage and uptime in real-time
+  - icon: 🎮
+    title: Easy to Manage
+    details: Simple and intuitive management interface for all your needs
+  - icon: 🔔
+    title: Notifications
+    details: Stay informed withalerts and notifications about your servers & applications status
+  - icon: ✨
+    title: Clean UI
+    details: Modern and user-friendly interface designed for the best user experience
 ---
 
 <style>

docs/notifications/Discord.md

@@ -0,0 +1,3 @@
+# Discord
+
+![Discord](../assets/screenshots/notifications_discord.png)

docs/notifications/Email.md

@@ -0,0 +1,3 @@
+# Email
+
+![Set up](../assets/screenshots/notifications_smtp.png)

docs/notifications/General.md

@@ -0,0 +1,6 @@
+# Notifications
+You can set the notifications for CoreControl in the settings. These notifications include when an application goes online or offline and when a server goes online or offline.
+
+![Notification Settings](../assets/screenshots/settings_notifications.png)
+
+You can also customize direct notification texts and improve them with placeholders

docs/notifications/Gotify.md

@@ -0,0 +1,3 @@
+# Gotify
+
+![Set up](../assets/screenshots/notifications_gotify.png)

docs/notifications/Ntfy.md

@@ -0,0 +1,3 @@
+# Ntfy
+
+![Set up](../assets/screenshots/notifications_ntfy.png)

docs/notifications/Telegram.md

@@ -0,0 +1,3 @@
+# Telegram
+
+![Telegram](../assets/screenshots/notifications_telegram.png)