Skip to main content

Dashy Docs

Note, for the most up-to-date documentation, please see the GitHub repository

1. Running Dashy

Quick-Start

TLDR Guide on running Dashy

Deployment

Deploying Dashy to any server

Configuring

All Config Options

Management

Updating, security, web server configuration, etc

Troubleshooting

Solutions to Common Issues

2. Feature Docs

Authentication

Configure login and user control

Alternate Views

Startpage mode, Workspace and opening methods

Backup & Restore

Cloud Sync, usage and background

Icons

Available icon types for sections and items

Language Switching

Changing language, and adding new locales

Pages & Sections

Multi-page support, sections, items and sub-items

REST API

Programmatically read and update your config

Status Indicators

Monitoring uptime of your services with Dashy

Search & Shortcuts

Filtering, web search and custom hotkeys

Theming

Guide to customizing the look and feel of Dashy

Widgets

List of all pre-built and custom widgets supported

3. Community

Developing

Dashy workflow, and running locally

Dev Guides

Common development tasks

Contributing

How you can help support Dashy's development

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

4. Misc

Privacy

All network requests, data storage and handling

Security

Security features, threat model and hardening

License

Licensing model of Dashy

Code of Conduct

Guidelines around Dashy

Changelog

View the latest changes and updates