mirror of
https://github.com/Lissy93/dashy.git
synced 2026-07-30 19:15:59 -04:00
daa576d30c
* feat: add ICMP ping check support to item * Replaced ping package with pingman package to be compliant with Dashy CI NodeJS version (20). Fixed a behavior bug in status indicator component which didn't changed icon to yellow when checking. Made otherStatusText a computed field to make it reflecting dynamically a new check request. Added more examples to default conf.yml * Removed a forgotten trace to console * Made changes requested by Lissy after review of the PR. Corrected tests using localhost which is not a valid host for pingman. Added a Validator.js file in src/utils with function to check validity of hosts. Reverted conf.yml file to the original version. * Fixed a problem in configuration of pingman call after adding support of IPV6 addresses. * Updated Dockerfile to pass Docker smoke tests in CI * Revert to latest version of `user-data/conf.yml` from `master` * Removed the duplicated feature line for ping check and just added `hosts` to the existing one * Removed the unused `shouldEnabledPingCheck` function * Add the ping system package and give rights to use to the node user so the pingman module can work in Docker container * Remove `src/utils/Validator.js` file. Rely on `pingman` internal validation of hostname instead to avoid command injection.
Running Dashy
- Quick Start - TLDR guide on getting Dashy up and running
- Deployment - Full guide on deploying Dashy either locally or online
- Configuring - Complete list of all available options in the config file
- App Management - Managing your app, updating, security, web server configuration, etc
- Troubleshooting - Common errors and problems, and how to fix them
Development and Contributing
- Developing - Running Dashy development server locally, and general workflow
- Development Guides - Common development tasks, to help new contributors
- Contributing - How you can help keep Dashy alive
- Showcase - See how others are using Dashy, and share your dashboard
- Credits - List of people and projects that have made Dashy possible
- Release Workflow - Info about releases, CI and automated tasks
Feature Docs
- Authentication - Guide to setting up authentication to protect your dashboard
- Alternate Views - Outline of available pages / views and item opening methods
- Backup & Restore - Guide to backing up config with Dashy's cloud sync feature
- Icons - Outline of all available icon types for sections and items, with examples
- Language Switching - Details on how to switch language, or add a new locale
- Pages and Sections - Multi-page support, sections, items and sub-items
- Status Indicators - Using Dashy to monitor uptime and status of your apps/services and hosts
- Searching & Shortcuts - Searching, launching methods + keyboard shortcuts
- Theming - Complete guide to applying, writing and modifying themes + styles
- Widgets - List of all dynamic content widgets, with usage guides and examples
Misc
- Privacy & Security - List of requests, potential issues, and security resources
- License - Copy of the MIT License
- Code of Conduct - Contributor Covenant Code of Conduct