mirror of https://github.com/Lissy93/dashy.git
2.3 KiB
2.3 KiB
Running Dashy
- Quick Start - TDLR 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
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 Dashy's cloud sync feature
- Icons - Outline of all available icon types for sections and items
- Language Switching - Details on how to switch language, or add a new locale
- Status Indicators - Using Dashy to monitor uptime and status of your apps
- Searching & Shortcuts - Finding and launching your apps, and using keyboard shortcuts
- Theming - Complete guide to applying, writing and modifying themes and styles
Misc
- Privacy & Security - List of requests, potential issues, and security resources
- License - Copy of the MIT License
- Legal - Licenses of direct dependencies
- Code of Conduct - Contributor Covenant Code of Conduct
- Changelog - Details of recent changes, and historical versions