Guide · Open source

How to use Dashy: install, configure and customize your dashboard

Updated 2026-10-29 · written with AI from the project's own documentation and checked against our catalogue data

Dashy is a self-hosted dashboard that puts your links, apps and services on one page. It is aimed at people running a homelab or home server, and at anyone who wants a customizable browser start page. This guide shows you how to start Dashy with Docker, where its configuration lives, and which features to set up first.

Dashylissy93/dashy · ★ 26.9k · MIT Install options & downloads

Quick start

1Install Docker. Make sure Docker is installed and running on the machine that will host Dashy.
2Start the container. Run docker run -p 4000:8080 lissy93/dashy and open the mapped port in your browser.
3Create a user-data folder. Create a host folder with a conf.yml file and mount it to /app/user-data so your settings persist.
4Add your links and services. Edit conf.yml, or use the built-in UI editor, to list your apps, links and hosts.
5Enable status checks and widgets. Turn on real-time status monitoring and add widgets that pull data from your self-hosted services.
6Pick a theme. Apply a built-in theme or add custom CSS through the UI.

Install Dashy with Docker

You need Docker installed on your system. The quickest way to start Dashy is to run the image from Docker Hub, which maps port 8080 inside the container to port 4000 on your machine.

Once the container is running, open the dashboard in your browser on the port you mapped. The README also shows a longer command for running it in the background with a persistent data folder.

Quick run: the image is lissy93/dashy on Docker Hub, also available as ghcr.io/lissy93/dashy on GHCR.
Images are multi-arch and work on amd64 and arm64.
A sample docker-compose.yml is included in the repository if you prefer Compose.

docker run -p 4000:8080 lissy93/dashy

Mount a user-data folder for your config

The mounted /app/user-data directory must contain at least a conf.yml file. Mounting a folder from your host means your settings survive container restarts and upgrades.

That folder can also hold sub-config files, item icons, fonts, custom CSS, or anything else you want served from the web root.

Mount your host folder to /app/user-data inside the container.
Make sure conf.yml exists in that folder before starting.

docker run -d \
  -p 4000:8080 \
  -v /path/to/your/user-data:/app/user-data \
  --name my-dashboard \
  --restart=always \
  lissy93/dashy:latest

Configure your links and services in conf.yml

Dashy is configured mainly through a single YAML file, located at ./user-data/conf.yml when you run from source. The README points to the configuration docs for the full list of options.

If you would rather not edit YAML by hand, the config can also be edited and saved directly through the built-in UI editor.

Edit conf.yml for the full set of options, including layout, sizes, text and component visibility.
Use the UI editor as an alternative to editing the file directly.
Full option reference: dashy.to/docs.

Use status checks and widgets

Dashy can monitor each of your apps, links and hosts in real time, so you can see at a glance whether a service is up. Widgets display information and dynamic content pulled from self-hosted services.

Status checks and widgets are part of the same config, so you set them up alongside your links rather than in a separate tool.

Real-time status monitoring for each app, link or host.
Widgets that show live info from self-hosted services.
Instant search by name, domain or tags, with customizable hotkeys and keyboard shortcuts.

Customize themes, icons and the start page

Dashy ships with several built-in color themes that you can preview, apply and edit through the UI. You can also add custom CSS for your own look.

For icons, the README lists Font-Awesome, homelab icons, auto-fetching favicons, images and emojis. A minimal view is available for use as a fast-loading browser start page.

Built-in themes with a UI color editor and support for custom CSS.
Icon options: Font-Awesome, homelab icons, auto-fetched favicons, images, emojis.
Minimal view for a browser start page.
Choose how links open: new tab, same tab, clipboard, pop-up modal, or workspace view.

Run Dashy from source instead of Docker

If you do not want to use Docker, the README describes deploying from source. You need an up-to-date Node LTS, git, and yarn enabled. Clone the repository, fill in your settings in ./user-data/conf.yml, then install, build and start.

The README links to a full list of Dashy's commands in the management docs.

Requires up-to-date Node LTS, git and yarn.
Steps: clone, configure conf.yml, install dependencies, build, run.

git clone https://github.com/Lissy93/dashy.git
cd dashy
yarn
yarn build
yarn start

What people use it for

A homelab dashboard that lists every self-hosted service on one page.
A browser start page with your links and a search box.
Checking whether your apps and hosts are up from a single view.
Showing live widget info from services you run at home.

Frequently asked questions

Is Dashy free?

Yes. The README describes Dashy as 100% free and open-source, and the project is released under the MIT licence. It also mentions an optional cloud backup feature that is described as free.

What do I need to run Dashy?

The README's install path needs Docker. To run from source instead, you need an up-to-date Node LTS, git and yarn.

How do I install Dashy?

Run docker run -p 4000:8080 lissy93/dashy, then open the mapped port in your browser. For persistent settings, mount a folder containing conf.yml to /app/user-data.

Do I have to edit YAML to configure Dashy?

No. Dashy is configured mainly through conf.yml, but the config can also be edited and saved through the built-in UI editor.

Is Dashy a good alternative to Homepage, Heimdall, Homarr or Flame?

Dashy is one of several self-hosted dashboards. The README lists Homepage, Heimdall, Homarr and Flame as comparable projects. Choose based on which configuration style and features you prefer, and try a few before committing.

Can I use Dashy as a browser start page?

Yes. The README describes a minimal view for use as a fast-loading browser start page, along with instant search.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Dashy suits homelab and self-hosting users who want one page for their services, status checks and widgets, and who are comfortable with Docker and a YAML file. If you want a zero-setup bookmark page or a fully managed hosted service, pick something else, since Dashy must be deployed and configured first.

Install options & downloads