• Stars
    star
    3,602
  • Rank 12,309 (Top 0.3 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 6 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Yet Another Clash Dashboard

yacd

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 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