Example Config Files for Dashy

April 14, 2022 ยท View on GitHub

Example Configuration Files for Dashy

Dashy is a self-hosted dashboard, to help you keep your lab organized

Dashy Quick Start

With Docker: docker run -p 8080:80 lissy93/dashy. See the Getting Started Docs for full setup instructions.

Example Config Files

This post contains several example files to help you get started

About the Config File

  • This conf.yml file contains all data and settings for your dashboard. It is located at /public/conf.yml, and written in YAML
  • If you're using Docker, you can use a --volume to pass the config file from your host system to Dashy, for example: -v /root/my-local-conf.yml:/app/public/conf.yml
  • After making changes to the configuration, the application need to be rebuilt. This should happen automatically once running, but a rebuild can also be manually triggered with yarn build (or docker exec -it [container-id] yarn build in Docker)
  • Changes to your config can also be made directly through the UI under the Config menu. And either written to disk, or applied locally
  • To check that your conf.yml is valid and matched Dashy's schema. Run yarn validate-config (or for Docker: docker exec -it [container-id] yarn build)

For full details and available fields, see the Configuring Documentation

Helpful Tools