Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haishanh/yacd
Yet Another Clash Dashboard
https://github.com/haishanh/yacd
Last synced: about 2 months ago
JSON representation
Yet Another Clash Dashboard
- Host: GitHub
- URL: https://github.com/haishanh/yacd
- Owner: haishanh
- License: mit
- Created: 2018-10-20T12:24:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T19:21:29.000Z (7 months ago)
- Last Synced: 2024-06-17T23:40:09.104Z (3 months ago)
- Language: TypeScript
- Homepage: http://yacd.haishan.me
- Size: 4.22 MB
- Stars: 3,803
- Watchers: 32
- Forks: 679
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - haishanh/yacd - Yet Another Clash Dashboard (TypeScript)
- my-awesome - haishanh/yacd - 02 star:4.0k fork:0.7k Yet Another Clash Dashboard (TypeScript)
README
> Yet Another [Clash](https://github.com/Dreamacro/clash) [Dashboard](https://github.com/Dreamacro/clash-dashboard)
## Usage
The site [http://yacd.haishan.me](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](https://github.com/haishanh/yacd/archive/gh-pages.zip), unzip and serve those static files with a web server(like Nginx).
**Docker image**
- Docker Hub [`haishanh/yacd`](https://hub.docker.com/r/haishanh/yacd)
- GitHub Container Registry [`ghcr.io/haishanh/yacd`](https://github.com/haishanh/yacd/pkgs/container/yacd)
```sh
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
```sh
# 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
```