更新说明文档

This commit is contained in:
Sun 2023-11-10 13:02:35 +08:00
parent 0a81db157b
commit c0e6400bcd

View File

@ -1,8 +1,17 @@
# Sun-Panel
一个NAS导航面板、Homepage、浏览器首页。
<div style="text-align: center;margin-bottom:10px">
<div style="font-size:50px;font-weight:700">Sun-Panel</div>
<div>
<a href="https://github.com/hslr-s/sun-panel.git">Github</a> |
<a href="https://gitee.com/hslr/sun-panel.git">Gitee</a>
</div>
<span style="font-size:25px">一个NAS导航面板、Homepage、浏览器首页。</span>
</div>
## 特点
![](./doc/images/icon-info.jpg)
## 😎 特点
- 局域网内外网链接切换
- 简洁
@ -11,20 +20,19 @@
- 无需连接外部数据库
- 丰富图标自由搭配(文字图标+svg图标+内置三方图标库)
- 支持网页内置小窗口打开(部分网站屏蔽此功能)
- 占用资源小
## 🫓 后面想做的事
## 后面想做的事
随心开发
先画个饼
- [ ] 图标排序
- [ ] 服务器监控
- [ ] docker管理器
- [ ] 计划任务
## 预览截图
![](./doc/images/icon-info.jpg)
## 🖼️ 预览截图
![](./doc/images/icon-small.jpg)
![](./doc/images/full-color-info.jpg)
![](./doc/images/full-color-small.jpg)
@ -33,7 +41,30 @@
![](./doc/images/window-ssh.png)
![](./doc/images/window-xunlei.png)
## 使用教程
## 🍜 使用教程
### 默认账号密码
账号admin@sun.cc
密码12345678
### 命令参数
|参数|说明|
|---|---|
|-h|查看命令说明|
|-config|生成配置文件conf/conf.ini|
|-password-reset|重置第一个用户的密码|
执行示例
```sh
./sun-panel -password-reset
```
输出
```
密码已经重置成功,以下是账号信息
用户名 xxx@qq.com
密码 12345678
```
### docker 运行