Lissy93/dashy
1
1
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2024-12-23 08:52:28 +03:00
Code Issues Packages Projects Releases Wiki Activity
99265d9241
dashy/docs
History
Alicia Sykes 99265d9241 🍻 Death by documentation... This will need spell checking in the morning
2021-07-26 22:43:46 +01:00
..
assets 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00
showcase 🌟 Adds homelab to showcase 2021-07-16 22:10:04 +01:00
authentication.md 📝 Updates docs :) 2021-06-22 22:32:03 +01:00
backup-restore.md Adds an example TOML file, and link to backend source code 2021-06-17 22:59:19 +01:00
configuring.md 📝 Adds docs for pageInfo.logo attribute 2021-07-26 20:50:53 +01:00
contributing.md 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00
credits.md 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00
deployment.md 📝 Adds docker-compose template to Deployment 2021-07-26 19:54:39 +01:00
developing.md 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00
development-guides.md 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00
icons.md 📝 Updates icon screenshots 2021-07-03 19:51:39 +01:00
management.md 📝 Creates a separate file for instance managmnet 2021-07-22 22:46:39 +01:00
readme.md 📝 New contents page for docs 2021-07-25 15:01:27 +01:00
showcase.md 🌟 Adds homelab to showcase 2021-07-16 22:10:04 +01:00
status-indicators.md 📝 Updates docs with new features for status checking header and url 2021-06-27 13:33:30 +01:00
theming.md 📝 Adds docs for the UI theme configurator 2021-07-18 20:47:15 +01:00
troubleshooting.md 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00

readme.md

Dashy Docs

Running Dashy

  • Deployment - Getting Dashy up and running
  • Configuring - Complete list of all available options in the config file
  • 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 to contribute to Dashy
  • Showcase - See how others are using Dashy, and share your dashboard

Feature Docs

  • Backup & Restore - Guide to Dashy's cloud sync feature
  • Status Indicators - Using Dashy to monitor uptime and status of your apps
  • Theming - Complete guide to applying, writing and modifying themes and styles
  • Icons - Outline of all available icon types for sections and items
  • Authentication - Guide to setting up authentication to protect your dashboard