External/CoreControl
1
0
Fork 0
mirror of https://github.com/crocofied/CoreControl.git synced 2025-12-29 16:14:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleanup v2

Browse Source
This commit is contained in:
headlesdev
2025-05-17 12:24:08 +02:00
parent 64b5b5e1c4
commit 8b82578809
318 changed files with 0 additions and 54608 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/general/Applications.md
View File

@@ -1,27 +0,0 @@
# 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)

31
docs/general/Dashboard.md
View File

@@ -1,31 +0,0 @@
# 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

3
docs/general/Network.md
View File

@@ -1,3 +0,0 @@
# 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.

80
docs/general/Servers.md
View File

@@ -1,80 +0,0 @@
# 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)

22
docs/general/Settings.md
View File

@@ -1,22 +0,0 @@
# Settings
Here you can manage the complete settings of CoreControl.
## User Settings
![User Settings](../assets/screenshots/settings_user.png)
You can change your email and password in the user settings. Please note that you need your old password to change your password.
## Theme Settings
![Theme Settings](../assets/screenshots/settings_theme.png)
With the theme settings you have the choice between light and dark mode. There is also the option to select “System”, where the system settings are applied.
## Language Settings
![Language Setting](../assets/screenshots/settings_language.png)
To promote internationalization (also often known as i18n), you can select the language in which you want everything to be displayed within CoreControl. Currently there is the standard language “English” and the language German.
## Notification Settings
![Notification Settings](../assets/screenshots/settings_notifications.png)
To receive notifications from CoreControl, you can add all your notification providers here. You can also customize the notification text.

7
docs/general/Uptime.md
View File

@@ -1,7 +0,0 @@
# 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)