blob: 7f314b0dc240948851fe8b0e60016862b2d753d5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
[中文](./README_CN.md)
> Yet Another [Clash](https://github.com/yaling888/clash) [Dashboard](https://github.com/yaling888/clash-dashboard)
## Usage
Install [twemoji](https://github.com/mozilla/twemoji-colr/releases) to display emoji better on Windows system.
The site http://yacd.metacubex.one 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/MetaCubeX/yacd/archive/gh-pages.zip), unzip and serve those static files with a web server(like Nginx).
**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) |
| title | Custom title for the webpage (displayed in browser tab) |
## Development
```sh
# install dependencies
# you may install pnpm with `npm i -g pnpm`
pnpm i
# start the dev server
# then go to http://127.0.0.1:3000
pnpm start
# build optimized assets
# ready to deploy assets will be in the directory `public`
pnpm build
```
|
