ducky!

a minimal and hackable dashboard for your homelab.

regular	minimal

minimal mode is accessible by putting ?min at the end of the URL like this: http://localhost:6767?min.

prerequisites

• docker and docker-compose
• bun (for development, tested on bun 1.3.11)

installation

# clone the git repository
git clone https://github.com/yaaaarn/ducky && cd ducky

# copy configuration files
cp docker-compose.example.yaml docker-compose.yaml
cp -r config.example config

# start the container
docker compose up -d

after starting, visit: http://localhost:6767

configuration

the config directory is located at ./config.

also note that you can add your own components by modifying the source directly or maintaining your own fork (recommended for long-term customization).

basic properties

title: big text
tagline: your very short description
description: |
  your very long description

variables

global config variables can be added as such:

variables:
  DOMAIN: mydoma.in
  ALT_DOMAIN: myseconddoma.in

and they can be used in items like this:

- name: git instance
  url: https://git.{DOMAIN}

components

item

- name: github
  url: https://github.com

grid

- type: grid
  items:
    - name: bluesky
      url: https://bsky.app

category

- type: category
  name: links
  emoji: 🔗
  open: true
  items:
    - name: google
      url: https://google.com
    - name: nekoweb
      url: https://nekoweb.org
    - name: discord
      url: https://discord.com

html

- type: html
  html: <strong>this is bold</strong>

search

- type: search
  placeholder: Search using DuckDuckGo!
  url: https://duckduckgo.com/search
  query: q

development

# clone git repository
git clone https://github.com/yaaaarn/ducky

# install dependencies
bun install

live server

this will open the server at http://localhost:3000.

bun run dev

building

running this will compile the entire source into a quick single-file executable.

bun run build

license

MIT