diff --git a/README.md b/README.md index df06260..eaeaf91 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,27 @@ -

- Clash -
- Clash Dashboard -
-

+# Clash and Dashboard +- 这是一个基于[Dreamacro/clash-dashboard](https://github.com/Dreamacro/clash-dashboard)修改的仓库 +- 项目用于将Dashboard管理页面直接打包进clash的docker镜像中,**实现一个容器同时启动Clash和Dashboard** +- 修改了后台接口部分代码,使后台只会连接到同一docker容器中clash的9090端口,不再需要配置即可直接管理。 +- 当然,因为去除了后台接口配置功能,所以此页面只能一对一了。 -

Web Dashboard for Clash, now host on ClashX

- -

- - Github Actions - -

- -## Features - - - All ClashX configurations - - Manage Proxies - - Manage Proxy Groups - - Realtime Log - -## Progress - -See [Projects](https://github.com/Dreamacro/clash-dashboard/projects) - -### Start develop with ClashX(Dev Mode) - -You can setup your local development environment with [the contribution guide](CONTRIBUTION.md). - -```bash -# Enable ClashX with Dev Mode -defaults write com.west2online.ClashX kEnableDashboard -bool YES - -# Set dashboard entry -defaults write com.west2online.ClashX webviewUrl "http://localhost:8080/" - -# Reset dashboard entry -defaults delete com.west2online.ClashX webviewUrl +## 打包 +```sh +docker build -f ./build/Dockerfile -t clash-and-dashboard:latest . ``` -### Development Env - -This command will start Clash Dashboard at `http://localhost:8080/` - -```bash -$ pnpm start +## 启动 +```sh +docker run -d \ + --name clash \ + -v clash.yaml:/root/.config/clash/config.yaml \ + -p 8080:8080 -p 7890:7890 \ + clash-and-dashboard:latest ``` -### Build for production - -```bash -$ pnpm build -``` - -## Contributors - - - -| [
Jason Chen](https://ijason.cc)
[🎨](#design-jas0ncn "Design") [💻](https://github.com/Dreamacro/clash-dashboard/commits?author=jas0ncn "Code") [🐛](https://github.com/Dreamacro/clash-dashboard/issues?q=author%3Ajas0ncn "Bug reports") [🤔](#ideas-jas0ncn "Ideas, Planning, & Feedback") [👀](#review-jas0ncn "Reviewed Pull Requests") [🌍](#translation-jas0ncn "Translation") | [
Dreamacro](https://github.com/Dreamacro)
[💻](https://github.com/Dreamacro/clash-dashboard/commits?author=Dreamacro "Code") [🐛](https://github.com/Dreamacro/clash-dashboard/issues?q=author%3ADreamacro "Bug reports") [🤔](#ideas-Dreamacro "Ideas, Planning, & Feedback") [👀](#review-Dreamacro "Reviewed Pull Requests") [🌍](#translation-Dreamacro "Translation") [📦](#platform-Dreamacro "Packaging/porting to new platform") | [
chs97](http://www.hs97.cn)
[💻](https://github.com/Dreamacro/clash-dashboard/commits?author=chs97 "Code") [🐛](https://github.com/Dreamacro/clash-dashboard/issues?q=author%3Achs97 "Bug reports") [👀](#review-chs97 "Reviewed Pull Requests") | [
Yicheng](https://github.com/yichengchen)
[🤔](#ideas-yichengchen "Ideas, Planning, & Feedback") [📦](#platform-yichengchen "Packaging/porting to new platform") | -| :---: | :---: | :---: | :---: | - +- 8080为管理界面端口 +- 7890为http端口 +- 7891为socks端口 +- 注意勾选允许局域网连接 ## LICENSE - MIT License