diff --git a/README.md b/README.md index 4b44592..6f0fe4c 100644 --- a/README.md +++ b/README.md @@ -21,57 +21,52 @@ [[ Document ]](https://sun-panel-doc.enianteam.com) | [[ Demo ]](http://sunpaneldemo.enianteam.com) -Server, NAS navigation panel, Homepage, Browser homepage. +A server, NAS navigation panel, Homepage, Browser homepage.
一个服务器、NAS导航面板、Homepage、浏览器首页。 - +![](./doc/images/main-dark.png) + +## 😎 Features + +- 🍉 Clean interface, powerful functionality, low resource consumption +- 🍊 Easy to use, visual operation, zero-code usage +- 🍠 One-click switch between internal and external network modes +- 🍵 Supports Docker deployment (compatible with Arm systems) +- 🎪 Supports multi-account isolation +- 🎏 Supports viewing system status +- 🫙 Supports custom JS, CSS +- 🍻 Simple usage without the need to connect to an external database +- 🍾 Rich icon styles for free combination, supports [Iconify icon library](https://icon-sets.iconify.design/) +- 🚁 Supports opening small windows in the webpage (some third-party websites may block this feature) + +## 🖼️ Preview Screenshots + +**Various styles, freely combined** + +![](./doc/images/icon-small-new.png) +![](./doc/images/transparent-info.png) +![](./doc/images/transparent-small.png) +![](./doc/images/solid-color-info.png) +![](./doc/images/full-color-small.jpg) + +**Built-in small windows** + +![](./doc/images/window-ssh.png) +![](./doc/images/window-xunlei.png) +## 🐳 Deployment tutorial +[Deployment Tutorial](https://sun-panel-doc.enianteam.com/usage/quick_deploy.html) -![](./doc/images/icon-info-new.png) +## 🍵 Donate -## 😎 特点 +> Open-source development is not easy. If you feel that my project has helped you, you are welcome to [donate](./doc/donate.md) or buy me a cup of tea☕ (please leave your nickname or name in the note if possible). Your support is my motivation, thank you. -- 简洁 -- 局域网内外网链接切换 -- docker部署,对arm系统支持 -- 上手简单，免修改代码 -- 无需连接外部数据库 -- 丰富图标自由搭配（文字图标+svg图标+内置三方图标库） -- 支持网页内置小窗口打开（部分网站屏蔽此功能） -- 占用资源小 - -## 🧊 最新完整文档（DOC） - -[最新完整文档（DOC）](https://sun-panel-doc.enianteam.com/) - - -## 🎨 演示（demo） - -[查看演示站](https://sun-panel-doc.enianteam.com/introduce/demo_site.html) - -## 🐳 交流群&社区 -开发者：**[红烧猎人](https://blog.enianteam.com/u/sun/content/11)** - -QQ交流群，进不去可以点上方连接联系作者 - - - -Github社区板块：https://github.com/hslr-s/sun-panel/discussions - -## 🍵 打赏 - -> 开源开发不易，如果觉得我的项目有帮到你，欢迎给我[打赏](./doc/donate.md)或者请我喝个奶茶☕（如果可以备注下您的昵称或者名字），你的支持就是我的动力，谢谢。 @@ -82,117 +77,23 @@ Github社区板块：https://github.com/hslr-s/sun-panel/discussions | ------------ | ------------ | | | | -## 🫓 TODO +## 🏖️ Communication group & community -- [x] 分组，拖拽排序 -- [x] 导入导出功能 -- [x] 增加访客账号 -- [x] 帐号解除邮箱限制 -- [x] 对上传的文件管理（针对账户增强重复利用，节省空间） -- [x] 服务器监控 -- [x] 多国语言支持 -- [ ] 用户自定义搜索框搜索引擎 -- [ ] 搜索框样式自定义（背景颜色，文字颜色） -- [ ] docker管理器 -- [ ] 计划任务 +Author：**[红烧猎人](https://blog.enianteam.com/u/sun/content/11)** +[Github Discussions](https://github.com/hslr-s/sun-panel/discussions) +QQ交流群，进不去可以点上方连接联系作者 -## 🖼️ 预览截图 + -**各种风格，自由搭配** - -![](./doc/images/icon-small-new.png) -![](./doc/images/transparent-info.png) -![](./doc/images/transparent-small.png) -![](./doc/images/solid-color-info.png) -![](./doc/images/full-color-small.jpg) - -**内置小窗口** - -![](./doc/images/window-ssh.png) -![](./doc/images/window-xunlei.png) - -## 🍜 使用运行教程 - -
- -### 默认账号密码 -账号：admin@sun.cc - -密码：12345678 - -### 命令参数 -|参数|说明| -|---|---| -|-h|查看命令说明| -|-config|生成配置文件（conf/conf.ini）| -|-password-reset|重置第一个用户的密码| - -### 二进制文件运行 - -去 [Releases](https://github.com/hslr-s/sun-panel/releases) 下载二进制文件 - -执行示例 - -```sh -./sun-panel -``` - -#### 重置密码 - -执行示例 - -```sh -./sun-panel -password-reset -``` -输出 -``` -密码已经重置成功，以下是账号信息 -用户名 xxx@qq.com -密码 12345678 -``` - -### docker 运行 - -目录挂载 `-v`，根据自己的需求选择： -|容器目录|说明| -|---|---| -|/app/conf|配置文件| -|/app/uploads|上传的文件| -|/app/database|数据库文件| -|/app/runtime|运行日志(不推荐挂载)| - -1. 拉取镜像 -```sh -docker pull hslr/sun-panel -``` - -2. 直接下载运行 -```sh -docker run -d --restart=always -p 3002:3002 \ --v ~/docker_data/sun-panel/conf:/app/conf \ --v ~/docker_data/sun-panel/uploads:/app/uploads \ --v ~/docker_data/sun-panel/database:/app/database \ ---name sun-panel \ -hslr/sun-panel -``` - - -### 自编译运行 - -[请参考完整文档](https://sun-panel-doc.enianteam.com/zh_cn/usage/compile.html) - -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=hslr-s/sun-panel&type=Date)](https://star-history.com/#hslr-s/sun-panel&Date) - - -## ❤️ 感谢 +## ❤️ Thanks - [Roc](https://github.com/RocCheng) - [jackloves111](https://github.com/jackloves111) - [Rock.L](https://github.com/gitlyp) -## LICENSE -[MIT](./LICENSE) \ No newline at end of file + +--- + +[![Star History Chart](https://api.star-history.com/svg?repos=hslr-s/sun-panel&type=Date)](https://star-history.com/#hslr-s/sun-panel&Date) diff --git a/doc/images/main-dark.png b/doc/images/main-dark.png new file mode 100644 index 0000000..7d95a61 Binary files /dev/null and b/doc/images/main-dark.png differ