swetoast / disk_endpoint

Disk Endpoint is a Flask application that provides an endpoint to get disk information. It uses the nvme list and smartctl commands to gather information about NVMe drives and other drives in the system. The information includes the name, model, serial number, and health status of each disk.

Disk Endpoint

Disk Endpoint is a Flask application that provides an endpoint to get disk information. It uses the nvme list and smartctl commands to gather information about NVMe drives and other drives in the system. The information includes the name, model, serial number, and health status of each disk.

Installation

Clone the repository:

 git clone https://github.com/yourusername/disk-endpoint.git

Configuration

The application reads its configuration from a file named disk_endpoint.conf in the same directory. Here’s an example of what the configuration file might look like:

[DEFAULT]
HOST = 127.0.0.1
PORT = 5000
USE_HTTPS = False
CERTIFICATE_PATH = /path/to/certificate.crt
KEY_PATH = /path/to/key.key
TOKEN = your_predefined_token

Replace /path/to/certificate.crt and /path/to/key.key with the actual paths to your SSL certificate and key files if you are using HTTPS and enable the boolean to True. Also, replace your_predefined_token with the actual token you want to use for authentication.

Systemd Service

You can also run the application as a systemd service. Here’s an example of a systemd service file:

[Unit]
Description=Disk Endpoint Flask Application
After=network.target

[Service]
User=root
WorkingDirectory=/path/to/your/directory/
ExecStart=python3 /path/to/your/directory/disk_endpoint.py
Restart=always

[Install]
WantedBy=multi-user.target

To use this service file:

Save it as disk-endpoint.service in the /etc/systemd/system directory.

Enable the service to start on boot with the command sudo systemctl enable disk-endpoint.service

Start the service with the command sudo systemctl start disk-endpoint.

You can check the status of the service with the command sudo systemctl status disk-endpoint.

Using with Home Assistant

You can use Disk Endpoint with Home Assistant by setting up a RESTful sensor. Here’s an example of how you might set it up:

sensor:
  - platform: rest
    resource: http://ip:port/disk_info?token=your_predefined_token
    name: Disk Info
    value_template: '{{ value_json.name }}'
    json_attributes:
      - model
      - serial
      - health_status

In this example, http://ip:port/disk_info?token=your_predefined_token with the actual URL of your Flask app’s endpoint and your actual token. The value_template is used to extract the value that will be displayed for the sensor in Home Assistant, and json_attributes is used to extract additional attributes from the JSON response.

License

This project is licensed under the terms of The Unlicense.