修改readme.md文件

This commit is contained in:
LaoYutang 2023-05-28 21:11:53 +08:00
parent 4c6d6068eb
commit 238369cd7a

View File

@ -1,66 +1,27 @@
<h1 align="center">
<img src="https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt="Clash" width="200">
<br>
Clash Dashboard
<br>
</h1>
# Clash and Dashboard
- 这是一个基于[Dreamacro/clash-dashboard](https://github.com/Dreamacro/clash-dashboard)修改的仓库
- 项目用于将Dashboard管理页面直接打包进clash的docker镜像中**实现一个容器同时启动Clash和Dashboard**
- 修改了后台接口部分代码使后台只会连接到同一docker容器中clash的9090端口不再需要配置即可直接管理。
- 当然,因为去除了后台接口配置功能,所以此页面只能一对一了。
<h4 align="center">Web Dashboard for Clash, now host on ClashX</h4>
<p align="center">
<a href="https://github.com/Dreamacro/clash-dashboard/actions">
<img src="https://img.shields.io/github/actions/workflow/status/Dreamacro/clash-dashboard/ghpages.yml?branch=master&style=flat-square" alt="Github Actions">
</a>
</p>
## 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
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars2.githubusercontent.com/u/3380894?v=4" width="100px;"/><br /><sub><b>Jason Chen</b></sub>](https://ijason.cc)<br />[🎨](#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") | [<img src="https://avatars1.githubusercontent.com/u/8615343?v=4" width="100px;"/><br /><sub><b>Dreamacro</b></sub>](https://github.com/Dreamacro)<br />[💻](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") | [<img src="https://avatars1.githubusercontent.com/u/12679581?v=4" width="100px;"/><br /><sub><b>chs97</b></sub>](http://www.hs97.cn)<br />[💻](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") | [<img src="https://avatars3.githubusercontent.com/u/11733500?v=4" width="100px;"/><br /><sub><b>Yicheng</b></sub>](https://github.com/yichengchen)<br />[🤔](#ideas-yichengchen "Ideas, Planning, & Feedback") [📦](#platform-yichengchen "Packaging/porting to new platform") |
| :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->
- 8080为管理界面端口
- 7890为http端口
- 7891为socks端口
- 注意勾选允许局域网连接
## LICENSE
MIT License