### Start Dash. Application (Linux) Source: https://getdashdot.com/docs/installation/from-source Execute this command with sudo to start the Dash. application on Linux systems after installation. ```bash sudo -E yarn start ``` -------------------------------- ### Install Dash. using Helm Chart with Override Values Source: https://getdashdot.com/docs/installation/helm Installs or upgrades the Dash. Helm chart, applying configurations from an override.yaml file. Ensure Helm is installed and configured for your Kubernetes cluster. ```bash helm upgrade --install dashdot oci://ghcr.io/oben01/charts/dashdot --namespace dashdot --create-namespace -f override.yaml ``` ```yaml ingress: enabled: true className: 'traefik' annotations: # Add any additional annotations as needed hosts: - host: dashdot.homelab.dev paths: - path: / pathType: ImplementationSpecific tls: - hosts: - 'dashdot.homelab.dev' - 'www.homelab.dev' secretName: homelab-dev-tls ``` -------------------------------- ### Start Dash. Application (Windows) Source: https://getdashdot.com/docs/installation/from-source Run this command in an elevated Command Prompt to start the Dash. application on Windows. ```cmd yarn start ``` -------------------------------- ### Retrieve Config Endpoint URL Source: https://getdashdot.com/docs/integration/api Example URL for accessing the configuration endpoint. ```text https:///config ``` -------------------------------- ### Config API Response Source: https://getdashdot.com/docs/integration/api Example response from the /config endpoint containing instance configuration settings. ```text https://dash.mauz.dev/config ``` ```json { "config": { "port": 3001, "routing_path": "/", "running_in_docker": true, "accept_ookla_eula": true, "fs_device_filter": [], "fs_type_filter": [ "cifs", "9p", "fuse.rclone", "fuse.mergerfs", "nfs4", "iso9660", "fuse.shfs", "autofs" ], "fs_virtual_mounts": [], "disable_integrations": false, "disable_background_stats_collection": false, "show_dash_version": "bottom_right", "show_host": false, "page_title": "dash.", "use_imperial": false, "network_speed_as_bytes": false, "always_show_percentages": true, "enable_cpu_temps": false, "cpu_temps_mode": "avg", "gpu_brand_filter": [], "gpu_model_filter": [], "widget_list": [ "os", "cpu", "storage", "ram", "network" ], "os_label_list": [ "os", "arch", "up_since" ], "cpu_label_list": [ "brand", "cores", "threads" ], "storage_label_list": [ "brand", "type", "size", "raid" ], "ram_label_list": [ "brand", "size" ], "network_label_list": [ "type", "speed_up", "speed_down" ], "gpu_label_list": [ "brand", "model", "memory" ], "os_widget_grow": 2.5, "os_widget_min_width": 300, "cpu_widget_grow": 4, "cpu_widget_min_width": 500, "cpu_shown_datapoints": 20, "cpu_poll_interval": 1000, "cpu_cores_toggle_mode": "toggle", "storage_widget_items_per_page": 3, "storage_widget_grow": 3.5, "storage_widget_min_width": 500, "storage_poll_interval": 60000, "ram_widget_grow": 4, "ram_widget_min_width": 500, "ram_shown_datapoints": 20, "ram_poll_interval": 1000, "speed_test_interval": 840, "network_widget_grow": 6, "network_widget_min_width": 500, "network_shown_datapoints": 20, "network_poll_interval": 1000, "gpu_widget_grow": 6, "gpu_widget_min_width": 700, "gpu_shown_datapoints": 20, "gpu_poll_interval": 1000, "override": { "cpu_brand": "QEMU", "storage_brands": { "vda": "QEMU" }, "storage_sizes": {}, "storage_types": {}, "gpu_brands": [], "gpu_models": [], "gpu_memories": [] } } } ``` -------------------------------- ### Retrieve Load Endpoint URL Source: https://getdashdot.com/docs/integration/api Example URL for accessing the CPU load endpoint. ```text https:///load/cpu ``` -------------------------------- ### GET /config Source: https://getdashdot.com/docs/integration/api Retrieves configuration settings for the running dash. instance, including enabled widgets. ```APIDOC ## GET /config ### Description Gives information about the configurations of the running instance. Mostly needed to read the enabled widgets at `config.widget_list`. ### Method GET ### Endpoint /config ### Response #### Success Response (200) - **config** (object) - Configuration details of the dash. instance. ### Response Example ```json { "config": { "port": 3001, "routing_path": "/", "running_in_docker": true, "accept_ookla_eula": true, "fs_device_filter": [], "fs_type_filter": [ "cifs", "9p", "fuse.rclone", "fuse.mergerfs", "nfs4", "iso9660", "fuse.shfs", "autofs" ], "fs_virtual_mounts": [], "disable_integrations": false, "disable_background_stats_collection": false, "show_dash_version": "bottom_right", "show_host": false, "page_title": "dash.", "use_imperial": false, "network_speed_as_bytes": false, "always_show_percentages": true, "enable_cpu_temps": false, "cpu_temps_mode": "avg", "gpu_brand_filter": [], "gpu_model_filter": [], "widget_list": [ "os", "cpu", "storage", "ram", "network" ], "os_label_list": [ "os", "arch", "up_since" ], "cpu_label_list": [ "brand", "cores", "threads" ], "storage_label_list": [ "brand", "type", "size", "raid" ], "ram_label_list": [ "brand", "size" ], "network_label_list": [ "type", "speed_up", "speed_down" ], "gpu_label_list": [ "brand", "model", "memory" ], "os_widget_grow": 2.5, "os_widget_min_width": 300, "cpu_widget_grow": 4, "cpu_widget_min_width": 500, "cpu_shown_datapoints": 20, "cpu_poll_interval": 1000, "cpu_cores_toggle_mode": "toggle", "storage_widget_items_per_page": 3, "storage_widget_grow": 3.5, "storage_widget_min_width": 500, "storage_poll_interval": 60000, "ram_widget_grow": 4, "ram_widget_min_width": 500, "ram_shown_datapoints": 20, "ram_poll_interval": 1000, "speed_test_interval": 840, "network_widget_grow": 6, "network_widget_min_width": 500, "network_shown_datapoints": 20, "network_poll_interval": 1000, "gpu_widget_grow": 6, "gpu_widget_min_width": 700, "gpu_shown_datapoints": 20, "gpu_poll_interval": 1000, "override": { "cpu_brand": "QEMU", "storage_brands": { "vda": "QEMU" }, "storage_sizes": {}, "storage_types": {}, "gpu_brands": [], "gpu_models": [], "gpu_memories": [] } } } ``` ``` -------------------------------- ### Clone and Build Dash. from Source (Linux) Source: https://getdashdot.com/docs/installation/from-source Use this command to clone the Dash. repository, install dependencies, and build the production version on Linux systems. ```bash git clone https://github.com/MauriceNino/dashdot \ && cd dashdot \ && yarn \ && yarn build:prod ``` -------------------------------- ### Clone and Build Dash. from Source (Windows) Source: https://getdashdot.com/docs/installation/from-source Use this command to clone the Dash. repository, install dependencies, and build the production version on Windows Command Prompt. ```cmd git clone https://github.com/MauriceNino/dashdot ^ && cd dashdot ^ && yarn ^ && yarn build:prod ``` -------------------------------- ### Info API Response Source: https://getdashdot.com/docs/integration/api Example response from the /info endpoint containing static system data. ```text https://dash.mauz.dev/info ``` ```json { "os": { "arch": "x64", "distro": "Debian GNU/Linux", "kernel": "6.12.57+deb13-amd64", "platform": "linux", "release": "13", "uptime": 3249056.47, "dash_version": "6.3.4", "dash_buildhash": "24cc5d61e10f5255a44f85b5b35d333a3b9bc6d8" }, "cpu": { "brand": "AMD", "model": "EPYC 9645", "cores": 12, "ecores": 0, "pcores": 12, "threads": 12, "frequency": null }, "ram": { "size": 33653686272, "layout": [ { "brand": "QEMU", "type": "RAM", "frequency": null } ] }, "storage": [ { "size": 1099511627776, "disks": [ { "device": "vda", "brand": "0x1af4", "type": "HD" } ] } ], "network": { "interfaceSpeed": 0, "speedDown": 2353255568, "speedUp": 2557340536, "lastSpeedTest": 1775539102322, "type": "Wired" }, "gpu": { "layout": [] } } ``` -------------------------------- ### Run Dashdot with Docker Source: https://getdashdot.com/docs/installation/docker Standard command to start the Dashdot container with host filesystem access and privileged mode. ```bash docker container run -it \ -p 80:3001 \ -v /:/mnt/host:ro \ --privileged \ mauricenino/dashdot ``` -------------------------------- ### Retrieve Info Endpoint URL Source: https://getdashdot.com/docs/integration/api Example URL for accessing the info endpoint. ```text https:///info ``` -------------------------------- ### Configure Dash. Port (Linux) Source: https://getdashdot.com/docs/installation/from-source Set the DASHDOT_PORT environment variable to '8080' and start the Dash. application on Linux. ```bash export DASHDOT_PORT="8080" \ && sudo -E yarn start ``` -------------------------------- ### Accept Speedtest License Source: https://getdashdot.com/docs/installation/from-source If you encounter speedtest-related errors, run this command to accept the license before starting the dashboard. ```bash speedtest --accept-license ``` -------------------------------- ### Configure Dash. Port (Windows) Source: https://getdashdot.com/docs/installation/from-source Set the DASHDOT_PORT environment variable to '8080' and start the Dash. application on Windows Command Prompt. ```cmd set DASHDOT_PORT=8080 ^ && yarn start ``` -------------------------------- ### GET /info Source: https://getdashdot.com/docs/integration/api Retrieves static information about the running dash. instance, including network speed test results. ```APIDOC ## GET /info ### Description Gives information about the static data of the running instance. Mostly needed to read the speed-test result at `network.speedDown` and `network.speedUp`. ### Method GET ### Endpoint /info ### Response #### Success Response (200) - **os** (object) - Operating system information. - **cpu** (object) - CPU information. - **ram** (object) - RAM information. - **storage** (array) - Storage information. - **network** (object) - Network information. - **gpu** (object) - GPU information. ### Response Example ```json { "os": { "arch": "x64", "distro": "Debian GNU/Linux", "kernel": "6.12.57+deb13-amd64", "platform": "linux", "release": "13", "uptime": 3249056.47, "dash_version": "6.3.4", "dash_buildhash": "24cc5d61e10f5255a44f85b5b35d333a3b9bc6d8" }, "cpu": { "brand": "AMD", "model": "EPYC 9645", "cores": 12, "ecores": 0, "pcores": 12, "threads": 12, "frequency": null }, "ram": { "size": 33653686272, "layout": [ { "brand": "QEMU", "type": "RAM", "frequency": null } ] }, "storage": [ { "size": 1099511627776, "disks": [ { "device": "vda", "brand": "0x1af4", "type": "HD" } ] } ], "network": { "interfaceSpeed": 0, "speedDown": 2353255568, "speedUp": 2557340536, "lastSpeedTest": 1775539102322, "type": "Wired" }, "gpu": { "layout": [] } } ``` ``` -------------------------------- ### Configure Dashdot Environment Variables Source: https://getdashdot.com/docs/installation/docker-compose Example of setting environment variables within the Docker Compose service definition. ```yaml services: dash: environment: DASHDOT_ENABLE_CPU_TEMPS: 'true' # ... ``` -------------------------------- ### Update Dash. Instance (Windows) Source: https://getdashdot.com/docs/installation/from-source Commands to update your Dash. instance on Windows by pulling the latest changes, installing dependencies, and rebuilding the production version. ```cmd git pull --rebase ^ && yarn ^ && yarn build:prod ``` -------------------------------- ### GET /load/{type} Source: https://getdashdot.com/docs/integration/api Retrieves the current load of a specific type (cpu, storage, ram, network, gpu) for the running dash. instance. ```APIDOC ## GET /load/{type} ### Description Has multiple sub-routes, each returning the current load of the given type. ### Method GET ### Endpoint /load/{type} ### Path Parameters - **type** (string) - Required - The type of load to retrieve. Possible values: `cpu`, `storage`, `ram`, `network`, `gpu`. ### Response #### Success Response (200) - The response structure varies depending on the `type` parameter. Refer to the examples for specific formats. ### Request Example `https:///load/cpu` ### Response Example (CPU Load) ```json { "cpu": { "brand": "AMD", "model": "EPYC 9645", "cores": 12, "ecores": 0, "pcores": 12, "threads": 12, "frequency": null } } ``` ``` -------------------------------- ### Update Dash. Instance (Linux) Source: https://getdashdot.com/docs/installation/from-source Commands to update your Dash. instance on Linux by pulling the latest changes, installing dependencies, and rebuilding the production version. ```bash git pull --rebase \ && yarn \ && yarn build:prod ``` -------------------------------- ### GET / (Iframe Integration) Source: https://getdashdot.com/docs/integration/widgets Embeds a Dash. graph into a webpage using an iframe with various query parameters for customization. ```APIDOC ## GET / ### Description Embeds a Dash. graph into a webpage. The graph is configured via query parameters appended to the source URL. ### Method GET ### Endpoint https:/// ### Parameters #### Query Parameters - **graph** (string) - Required - The specific graph to show (cpu, storage, ram, network, gpu). - **multiView** (boolean) - Optional - Enables multi-device views for cpu and storage widgets. - **filter** (string) - Optional - Filters multi-graph views (network: up/down; gpu: load/memory). - **showPercentage** (boolean) - Optional - Displays a label with the current percentage. - **theme** (string) - Optional - Overrides the theme (dark, light). - **color** (string) - Optional - Overrides the graph color (hex string without #). - **surface** (string) - Optional - Overrides the background color (hex string without #). - **innerRadius** (string) - Optional - Changes the border-radius on the graphs. - **gap** (string) - Optional - Changes the gap between graphs. - **textSize** (string) - Optional - Changes the font-size of text elements. - **textOffset** (string) - Optional - Changes the margin of text elements. ### Request Example ``` -------------------------------- ### Server Widget Options Source: https://getdashdot.com/docs/configuration/server Configure which data is displayed in the server widget and whether to show host information. ```APIDOC ## Server Widget Options ### `DASHDOT_OS_LABEL_LIST` Selects which data is shown in the server widget. The available options are: `os`, `arch`, `up_since`, `dash_version`. * type: `string (comma separated list)` * default: `os,arch,up_since` ### `DASHDOT_SHOW_HOST` If you want to show the host part in the server widget (e.g. `dash.` -> `dash.mauz.dev`). * type: `boolean` * default: `false` ### `DASHDOT_CUSTOM_HOST` If you want to show a custom host in the server widget (needs `DASHDOT_SHOW_HOST` enabled to work). * type: `string` * default: `unset` ``` -------------------------------- ### Run Dashdot with GPU Support Source: https://getdashdot.com/docs/installation/docker Deploy the NVIDIA-specific image tag with GPU access enabled. ```bash docker container run -it \ -p 80:3001 \ -v /:/mnt/host:ro \ --privileged \ --gpus all \ --env DASHDOT_WIDGET_LIST="os,cpu,storage,ram,network,gpu" \ mauricenino/dashdot:nvidia ``` -------------------------------- ### CPU Widget Options Source: https://getdashdot.com/docs/configuration/cpu Configure the data displayed and behavior of the CPU widget. ```APIDOC ## CPU Widget Options ### `DASHDOT_CPU_LABEL_LIST` Selects which data is shown in the CPU widget. * **Type**: `string` (comma separated list) * **Default**: `brand,model,cores,threads,frequency` * **Available Options**: `brand`, `model`, `cores`, `threads`, `frequency` ### `DASHDOT_ENABLE_CPU_TEMPS` If you want to show the CPU temperature in the graph. This will probably not work on a VPS, so you need to try it on your own if this works. For home servers it might work just fine. * **Type**: `boolean` * **Default**: `false` * **Options**: `true`, `false` **Note**: If you want to show the data using imperial units, you need to set the `DASHDOT_USE_IMPERIAL` option to `true`. ### `DASHDOT_CPU_TEMPS_MODE` To choose between average and max CPU temperature (across all cores). Needs `DASHDOT_ENABLE_CPU_TEMPS` enabled to work. * **Type**: `string` * **Default**: `avg` * **Available Options**: `avg`, `max` ### `DASHDOT_CPU_CORES_TOGGLE_MODE` Switches the Processor core view depending on the selected option. The `toggle` option allows you to switch the view from the dashboard, other options hide the toggle from the dashboard. * **Type**: `string` * **Default**: `toggle` * **Available Options**: `toggle`, `multi-core`, `average` ``` -------------------------------- ### Configure Dashdot via Environment Variables Source: https://getdashdot.com/docs/installation/docker Pass configuration options to the container using the --env flag. ```bash docker container run -it \ --env DASHDOT_ENABLE_CPU_TEMPS="true" \ # ... ``` -------------------------------- ### Check system mount paths Source: https://getdashdot.com/docs/faq Use this command in a shell to identify all mount paths on your system for manual volume configuration. ```bash df ``` -------------------------------- ### GPU Styling Parameters Source: https://getdashdot.com/docs/configuration/gpu Environment variables to adjust the visual appearance and polling behavior of the GPU widget. ```APIDOC ## GPU Styling Parameters ### DASHDOT_GPU_WIDGET_GROW - **Type**: number - **Default**: 6 - **Description**: Adjusts the relative size of the GPU widget. ### DASHDOT_GPU_WIDGET_MIN_WIDTH - **Type**: number - **Default**: 700 - **Description**: Adjusts the minimum width of the GPU widget (in px). ### DASHDOT_GPU_SHOWN_DATAPOINTS - **Type**: number - **Default**: 20 - **Description**: The amount of datapoints in the GPU graph. ### DASHDOT_GPU_POLL_INTERVAL - **Type**: number - **Default**: 1000 - **Description**: Read the GPU load every x milliseconds. ``` -------------------------------- ### Deploy Dashdot with Docker Compose Source: https://getdashdot.com/docs/installation/docker-compose Standard configuration for running Dashdot as a container with host filesystem access. ```yaml version: '3.5' services: dash: image: mauricenino/dashdot:latest restart: unless-stopped privileged: true ports: - '80:3001' volumes: - /:/mnt/host:ro ``` -------------------------------- ### GPU Configuration Options Source: https://getdashdot.com/docs/configuration/gpu Environment variables to control data display and filtering for the GPU widget. ```APIDOC ## GPU Configuration Options ### DASHDOT_GPU_LABEL_LIST - **Type**: string (comma separated list) - **Default**: brand, model, memory - **Description**: Selects which data is shown in the gpu widget. ### DASHDOT_GPU_BRAND_FILTER - **Type**: string (comma separated list) - **Default**: unset - **Description**: A comma-separated list of brands to show in the gpu widget. Case sensitive. ### DASHDOT_GPU_MODEL_FILTER - **Type**: string (comma separated list) - **Default**: unset - **Description**: A comma-separated list of models to show in the gpu widget. Case sensitive. ``` -------------------------------- ### RAM Configuration Variables Source: https://getdashdot.com/docs/configuration/ram Environment variables for controlling the RAM widget display options, widget styling, and data polling intervals. ```APIDOC ## RAM Configuration ### Options - **DASHDOT_RAM_LABEL_LIST** (string) - Optional - Comma separated list of data to show in the RAM widget. Options: brand, size, type, frequency. Default: brand,size,type,frequency ### Styles - **DASHDOT_RAM_WIDGET_GROW** (number) - Optional - Relative size of the Memory widget. Default: 4 - **DASHDOT_RAM_WIDGET_MIN_WIDTH** (number) - Optional - Minimum width of the Memory widget in px. Default: 500 - **DASHDOT_RAM_SHOWN_DATAPOINTS** (number) - Optional - Amount of datapoints in the Memory graph. Default: 20 - **DASHDOT_RAM_POLL_INTERVAL** (number) - Optional - Memory load polling interval in milliseconds. Default: 1000 ``` -------------------------------- ### Server Widget Overrides Source: https://getdashdot.com/docs/configuration/server Apply custom overrides for operating system and architecture information. ```APIDOC ## Server Widget Overrides ### `DASHDOT_OVERRIDE_OS` * type: `string` * default: `unset` ### `DASHDOT_OVERRIDE_ARCH` * type: `string` * default: `unset` ``` -------------------------------- ### Server Widget Styles Source: https://getdashdot.com/docs/configuration/server Adjust the visual appearance and sizing of the server widget. ```APIDOC ## Server Widget Styles ### `DASHDOT_OS_WIDGET_GROW` To adjust the relative size of the OS widget. * type: `number` * default: `2.5` ### `DASHDOT_OS_WIDGET_MIN_WIDTH` To adjust the minimum width of the OS widget (in px). * type: `number` * default: `300` ``` -------------------------------- ### Enable GPU Support in Docker Compose Source: https://getdashdot.com/docs/installation/docker-compose Configuration for the nvidia image tag, requiring device capability reservations for GPU access. ```yaml version: '3.5' services: dash: image: mauricenino/dashdot:nvidia restart: unless-stopped privileged: true deploy: resources: reservations: devices: - capabilities: - gpu ports: - '80:3001' volumes: - /:/mnt/host:ro environment: DASHDOT_WIDGET_LIST: 'os,cpu,storage,ram,network,gpu' ``` -------------------------------- ### Set Network Speed Test Interval (Cron) Source: https://getdashdot.com/docs/configuration/network Configure the network speed test interval using a cron string. This overrides the standard interval setting. ```string 0 0 * * * ``` -------------------------------- ### CPU Widget Styles Source: https://getdashdot.com/docs/configuration/cpu Adjust the visual appearance and performance of the CPU widget. ```APIDOC ## CPU Widget Styles ### `DASHDOT_CPU_WIDGET_GROW` To adjust the relative size of the Processor widget. * **Type**: `number` * **Default**: `4` ### `DASHDOT_CPU_WIDGET_MIN_WIDTH` To adjust the minimum width of the Processor widget (in px). * **Type**: `number` * **Default**: `500` ### `DASHDOT_CPU_SHOWN_DATAPOINTS` The amount of datapoints in the Processor graph. * **Type**: `number` * **Default**: `20` ### `DASHDOT_CPU_POLL_INTERVAL` Read the Processor load every x milliseconds. * **Type**: `number` * **Default**: `1000` ``` -------------------------------- ### Embed Dash. Widget via Iframe Source: https://getdashdot.com/docs/integration/widgets Basic implementation of a Dash. widget using an iframe. Replace with your actual instance address. ```html ``` ```html ``` -------------------------------- ### Identify Storage Device Names Source: https://getdashdot.com/docs/configuration/storage Use this structure to identify device names from the dash. logs for use in filtering or override parameters. ```javascript storage: { layout: [ { // highlight-next-line device: 'nvme0n1', brand: 'Samsung', size: 500107862016, type: 'NVMe', raidGroup: '', }, { // highlight-next-line device: 'sda', brand: 'DELL', size: 4000225165312, type: 'HD', raidGroup: '', }, ]; } ``` -------------------------------- ### GPU Load API Source: https://getdashdot.com/docs/integration/api Retrieves the current GPU load information. ```APIDOC ## GET /load/gpu ### Description Retrieves the current GPU load information. The structure may vary based on GPU configuration. ### Method GET ### Endpoint https://dash.mauz.dev/load/gpu ### Response #### Success Response (200) - **layout** (array) - An array representing the GPU layout or load details. This field might be empty if no specific details are available. #### Response Example ```json { "layout": [] } ``` ``` -------------------------------- ### GPU Data Overrides Source: https://getdashdot.com/docs/configuration/gpu Environment variables to manually set GPU data for systems where automatic gathering is not possible. ```APIDOC ## GPU Data Overrides ### DASHDOT_OVERRIDE_GPU_BRANDS - **Type**: string - **Default**: unset - **Description**: Pass a comma-separated list of brands of your GPUs. ### DASHDOT_OVERRIDE_GPU_MODELS - **Type**: string - **Default**: unset - **Description**: Pass a comma-separated list of models of your GPUs. ### DASHDOT_OVERRIDE_GPU_MEMORIES - **Type**: string - **Default**: unset - **Description**: Pass a comma-separated list of memory-sizes of your GPUs. ``` -------------------------------- ### CPU Load API Source: https://getdashdot.com/docs/integration/api Retrieves the current CPU load for each core. ```APIDOC ## GET /load/cpu ### Description Retrieves the current CPU load for each core, including load percentage and temperature. ### Method GET ### Endpoint https://dash.mauz.dev/load/cpu ### Response #### Success Response (200) - **load** (number) - The CPU load percentage for a specific core. - **temp** (number) - The temperature of the CPU core. - **core** (integer) - The identifier for the CPU core. #### Response Example ```json [ { "load": 4.040404040404041, "temp": 0, "core": 0 }, { "load": 5.154639175257731, "temp": 0, "core": 1 } ] ``` ``` -------------------------------- ### RAM Data Overrides Source: https://getdashdot.com/docs/configuration/ram Environment variables to manually override statically gathered RAM data, useful for VPS or restricted environments. ```APIDOC ## RAM Overrides ### Parameters - **DASHDOT_OVERRIDE_RAM_BRAND** (string) - Optional - Manually set the RAM brand. - **DASHDOT_OVERRIDE_RAM_SIZE** (number) - Optional - Manually set the RAM size in bytes. - **DASHDOT_OVERRIDE_RAM_TYPE** (string) - Optional - Manually set the RAM type. - **DASHDOT_OVERRIDE_RAM_FREQUENCY** (number) - Optional - Manually set the RAM frequency. ``` -------------------------------- ### Configure Speed Test Results Path Source: https://getdashdot.com/docs/configuration/network Specify a local file path for speed test results. Useful for disabling automatic speed tests by providing maximum values. ```json { "unit": "bit", "speedDown": 150000000, "speedUp": 50000000, "publicIp": "123.123.123.123" } ``` -------------------------------- ### Storage Load API Source: https://getdashdot.com/docs/integration/api Retrieves the current storage load information. ```APIDOC ## GET /load/storage ### Description Retrieves the current storage load, typically represented as total bytes. ### Method GET ### Endpoint https://dash.mauz.dev/load/storage ### Response #### Success Response (200) - **storage** (integer) - The total storage in bytes. #### Response Example ```json [ 721864513536 ] ``` ``` -------------------------------- ### RAM Load API Source: https://getdashdot.com/docs/integration/api Retrieves the current RAM load information. ```APIDOC ## GET /load/ram ### Description Retrieves the current RAM load, typically represented in bytes. ### Method GET ### Endpoint https://dash.mauz.dev/load/ram ### Response #### Success Response (200) - **load** (integer) - The current RAM load in bytes. #### Response Example ```json { "load": 27774144512 } ``` ``` -------------------------------- ### CPU Data Overrides Source: https://getdashdot.com/docs/configuration/cpu Manually set CPU data if automatic gathering fails or is not applicable. ```APIDOC ## CPU Data Overrides You can use overrides to manually set statically gathered data. This is useful if you want to use dashdot on a VPS or a system where the data cannot be gathered automatically. ### `DASHDOT_OVERRIDE_CPU_BRAND` * **Type**: `string` * **Default**: `unset` ### `DASHDOT_OVERRIDE_CPU_MODEL` * **Type**: `string` * **Default**: `unset` ### `DASHDOT_OVERRIDE_CPU_CORES` * **Type**: `number` * **Default**: `unset` ### `DASHDOT_OVERRIDE_CPU_THREADS` * **Type**: `number` * **Default**: `unset` ### `DASHDOT_OVERRIDE_CPU_FREQUENCY` Number needs to be passed in GHz (e.g. `2.8`). * **Type**: `number` * **Default**: `unset` ``` -------------------------------- ### Uninstall Dash. Helm Chart Source: https://getdashdot.com/docs/installation/helm Removes the Dash. deployment from Kubernetes, including all associated components and persistent volumes. This command deletes the Helm release. ```bash helm uninstall dashdot ``` -------------------------------- ### Network Load API Source: https://getdashdot.com/docs/integration/api Retrieves the current network traffic load (upload and download speeds). ```APIDOC ## GET /load/network ### Description Retrieves the current network traffic load, including upload and download speeds in bytes per second. ### Method GET ### Endpoint https://dash.mauz.dev/load/network ### Response #### Success Response (200) - **up** (number) - The current upload speed in bytes per second. - **down** (number) - The current download speed in bytes per second. #### Response Example ```json { "up": 329484.625572552, "down": 60951.88182853307 } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.