heartleo / yacd

Yet Another Clash Dashboard

Yet Another Clash Dashboard

Usage

The site http://yacd.haishan.me is served with HTTP not HTTPS is because many browsers block requests to HTTP resources from a HTTPS website. If you think it's not safe, you could just download the zip of the gh-pages, unzip and serve those static files with a web server(like Nginx).

Docker image

• Docker Hub haishanh/yacd
• GitHub Container Registry ghcr.io/haishanh/yacd

docker run -p 1234:80 -d --name yacd --rm ghcr.io/haishanh/yacd:master

# and then open http://localhost:1234 in your browser

Supported URL query params

Param	Description
hostname	Hostname of the clash backend API (usually the host part of external-controller)
port	Port of the clash backend API (usually the port part of external-controller)
secret	Clash API secret (secret in your config.yaml)
theme	UI color scheme (dark, light, auto)

Development

# install dependencies
# you may install pnpm with `npm i -g pnpm`
pnpm i

# start the dev server
# then go to the url printed on the screen
pnpm start


# build optimized assets
# ready to deploy assets will be in the directory `public`
pnpm build