HardWatch Client

Overview

HardWatch Client is an application designed to monitor and collect real-time system performance metrics. It sends this data to the HardWatch Server and allows remote execution of commands via a web interface or the ZeppOS app.

Features

• Resource Monitoring: Collects and tracks CPU, GPU, RAM, and disk usage.
• Server Communication: Sends performance data to a HardWatch Server.
• Discord Rich Presence Integration: Displays system usage stats on Discord (configurable).
• Remote Command Execution: Executes predefined commands from the web app or ZeppOS app.
• Tray Icon: Since this doesn't have any user interface and runs in background, It stays running on the tray where you can easily close the program

Configuration

Before running the application, you need to set up a config.json file in the root directory. Below is the required structure, you can also use the Web editor to easily create a configuration file:

{
    "name": "<Device alias>",
    "appKey": "<Server app key>",
    "backendUrl": "<Server URL>",
    "type": "<Device type (desktop | laptop | handheld | server)>",
    "enableDiscordRPC": false,
    "includeDockerServices": false,
    "disableNotifications:":false,
    "customIp":"<Leave in blank if want to use device's local ip>",
    "services":[
        {
            "id": "<Service unique identifier>",
            "name": "<Service name>",
            "port": "<Service port>",
            "type": "<web,code,database,file,video,remote-control,ssh,dev-server,other>"
        }
    ],
    "actionables": [
        {
            "name": "<Actionable name>",
            "action": "<Actionable command>"
        }
    ]
}

Configuration Parameters

Parameter	Description
name	Alias for identifying the device.
appKey	Authentication key for connecting to the HardWatch server.
backendUrl	URL of the HardWatch server.
type	Specifies the type of device: desktop, laptop, handheld, or server.
enableDiscordRPC	Boolean value (true or false) to enable or disable Discord Rich Presence integration.
includeDockerServices	Boolean value (true or false) to enable or disable reading services from docker.
disableNotifications	Disables native notifications
customIp	Set device's custom ip to show on services instead of device's local ip
services	List of manually set services that can be running on this device
services.id	Service unique identifier
services.name	Service name
services.port	Service port
services.type	Service type used to displa a custom icon on the frontend, could be: web,code,database,file,video,remote-control,ssh,dev-server,other
actionables	List of commands that can be executed remotely.
actionables.name	The name of the command.
actionables.action	The exact command to be executed.

Example Configuration

{
    "name": "Gaming PC",
    "appKey": "my-secure-key",
    "backendUrl": "http://localhost:3000",
    "type": "desktop",
    "enableDiscordRPC": true,
    "actionables": [
        {
            "name": "Restart Explorer",
            "action": "taskkill /f /im explorer.exe && start explorer.exe"
        },
        {
            "name": "Clear Temp Files",
            "action": "del /q/f/s %TEMP%\*"
        }
    ]
}

Usage

You can run the HardWatch Client in multiple ways:

Run the install command

bash <(curl -s https://raw.githubusercontent.com/Gr3gorywolf/HardWatch-client/main/scripts/release-install.sh)

Using Precompiled Binaries

1. Download the appropriate binary from the Releases page.
2. Run the executable for your platform (Windows, macOS, or Linux).

Running with Docker

1. Clone the repository:

   git clone https://github.com/Gr3gorywolf/HardWatch-client.git
   cd HardWatch-client

2. Start the container:

   docker-compose up

Running from Source

1. Install dependencies:

   pip install -r requirements.txt

2. Run the application:

   python3 client.py

General Workflow

1. The client will connect to the specified server and begin sending system performance data.
2. If Discord Rich Presence is enabled, hardware stats will be displayed in your Discord status.
3. Use the web app or ZeppOS app to send remote commands to the client.

Contributing

If you want to contribute to HardWatch Client, feel free to fork the repository, create a feature branch, and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Links

• ZeppOs App: ZeppOs App
• Server Repository: HardWatch Server
• Releases: Download Latest Version