-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
145 additions
and
106 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# Update Instructions | ||
|
||
::: danger Note | ||
**Please make sure to back up your data before upgrading, especially the mount directories for Docker versions!!!** This is especially important when upgrading to beta versions, always back up! | ||
|
||
If there is no effect after the update, remember to **clear the browser cache**. | ||
<!-- [Clear Browser Cache](https://blog.csdn.net/m0_46156566/article/details/108519629) --> | ||
::: | ||
|
||
## Version Naming Convention | ||
|
||
#### Rules: | ||
|
||
`[Major Version]`.`[Minor Version]`.`[Stable/Minor Feature Update/Bug Fix]`-`[Testing/Development][Date]` | ||
|
||
#### Examples: | ||
- `v1.3.1-beta24-02-28` Beta version | ||
- `v1.3.1` Stable version / Minor feature update / Bug fix | ||
|
||
#### Version Chronological Order Example: | ||
|
||
`v1.3.1` > `v1.3.1-beta24-02-28` > `v1.3.0` > `v1.3.0-beta24-02-20` | ||
|
||
## Docker Version | ||
|
||
### 1. Go to [DockerHub](https://hub.docker.com/r/hslr/sun-panel/tags) and find the corresponding version | ||
|
||
Please note that Docker version numbers do not include `v` | ||
|
||
![](/images/update_log/docker_hub_beta.png) | ||
|
||
### 2. Copy the command to download | ||
|
||
Example | ||
```sh | ||
# Latest stable version | ||
docker pull hslr/sun-panel:latest | ||
|
||
# Latest beta version | ||
docker pull hslr/sun-panel:beta | ||
|
||
# Other specific versions (version numbers should not have 'v' at the beginning) | ||
docker pull hslr/sun-panel:1.4.0 | ||
docker pull hslr/sun-panel:1.4.0-beta24-02-20 | ||
``` | ||
|
||
### 3. Synology or other GUI operations | ||
Directly select the tag you want to use for pulling, create a new container to run, and ensure the mount path is consistent with the old version. If tag filtering is not supported, run it in the following command line manner | ||
|
||
### 4. Command line operation (Mount directory consistent with the old version) | ||
It is recommended to create a new container to run, which can be restored in time if there are problems, | ||
```sh | ||
docker run -d --restart=always -p 3002:3002 \ | ||
-v ~/docker_data/sun-panel/conf:/app/conf \ | ||
--name sun-panel \ | ||
hslr/sun-panel:latest | ||
``` | ||
Replace `latest` in the above command with any existing version tag, and modify other parameters according to your own needs. | ||
|
||
## Binary Version | ||
|
||
::: tip | ||
Go to Github [Releases](https://github.com/hslr-s/sun-panel/releases) to download the binary file. | ||
::: | ||
|
||
After downloading, cover the `web` folder and `executable binary file` in the compressed package, and run it again. | ||
|
||
---- | ||
Related references: <a href="../usage/quick_deploy">Deployment Tutorial</a> | <a href="https://www.bilibili.com/video/BV1ke411y7B5" target="_blank">[Bilibili] Beta Update Video Tutorial</a> | <a href="https://youtu.be/wRo-azoAbsQ?si=ZNSKm89bx0yq5Puw" target="_blank">[YouTube] Beta Update Video Tutorial</a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1 @@ | ||
|
||
::: danger Proceed with Caution | ||
Beta versions are testing versions before the official release and may contain serious bugs. **Always back up before upgrading!!!** | ||
|
||
In Docker, the `latest` tag represents the official version or a stable beta version and does not update to unstable beta versions. | ||
|
||
Examples of `beta` or `[major version]-beta date` are like `1.4.0-beta24-02-20`, all indicating beta versions. | ||
|
||
After updating, if there are no changes, remember to [clear your browser cache](https://blog.csdn.net/m0_46156566/article/details/108519629). | ||
::: | ||
|
||
## Docker Versions | ||
|
||
### 1. Visit the [Sun-Panel project page](https://hub.docker.com/r/hslr/sun-panel/tags) on DockerHub. Beta versions are indicated with a beta tag + date in the tags row. | ||
|
||
![](/images/update_log/docker_hub_beta.png) | ||
|
||
### 2. Copy the command to download (make sure it's not `latest`). | ||
|
||
Example: | ||
``` | ||
# Latest beta version | ||
docker pull hslr/sun-panel:beta | ||
# Replace beta24-02-20 with the specific version number | ||
docker pull hslr/sun-panel:1.4.0-beta24-02-20 | ||
``` | ||
|
||
### 3. For Synology NAS or other visual operations | ||
Select the tag with `beta` or `beta+date` to pull. Create a new container to run. If filtering tags is not supported, follow the command line method below. | ||
|
||
### 4. Command Line Execution (mount directories same as official version) | ||
It's recommended to create a new container to run. If there are issues, you can revert quickly. | ||
```sh | ||
docker run -d --restart=always -p 3002:3002 \ | ||
-v ~/docker_data/sun-panel/conf:/app/conf \ | ||
--name sun-panel \ | ||
hslr/sun-panel:beta | ||
``` | ||
Replace `hslr/sun-panel:beta` in the above command with the latest beta version tag. Modify other parameters as needed. | ||
|
||
|
||
## Binary Versions | ||
|
||
::: tip | ||
Go to Github [Releases](https://github.com/hslr-s/sun-panel/releases) to download the binary files. | ||
::: | ||
|
||
After downloading, extract the `web` folder and the `executable binary file`, overwrite, and then run again. | ||
|
||
---- | ||
For complete deployment, refer to: [Deployment Tutorial](../usage/quick_deploy) | [Bilibili Beta Update Video Tutorial](https://www.bilibili.com/video/BV1ke411y7B5) | ||
# Please move [Update instructions](./update) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# 更新说明 | ||
|
||
::: danger 说明 | ||
**升级请务必自行备份数据,docker 版本要备份挂载目录!!!**,特别是升级 beta 版本,一定要备份! | ||
|
||
如果更新完成没有任何效果记得 **清除浏览器缓存**。 | ||
<!-- [清除浏览器缓存](https://blog.csdn.net/m0_46156566/article/details/108519629)) --> | ||
::: | ||
|
||
## 版本命名说明 | ||
|
||
#### 规则: | ||
|
||
`[大版本]`.`[小版本]`.`[正式版本/小功能更新/修复bug]`-`[测试/开发][日期]` | ||
|
||
#### 示例: | ||
- `v1.3.1-beta24-02-28` beta版本 | ||
- `v1.3.1` 正式版本 / 小功能更新 / 修复bug | ||
|
||
#### 版本从新到旧时间排序示例: | ||
|
||
`v1.3.1` > `v1.3.1-beta24-02-28` > `v1.3.0` > `v1.3.0-beta24-02-20` | ||
|
||
## docker 版本 | ||
|
||
### 1. 进入到 [DockerHub](https://hub.docker.com/r/hslr/sun-panel/tags),找到对应的版本 | ||
|
||
请注意 docker 版本号不带 `v` | ||
|
||
![](/images/update_log/docker_hub_beta.png) | ||
|
||
### 2. 复制指令下载 | ||
|
||
示例 | ||
``` | ||
# 最新正式版本 | ||
docker pull hslr/sun-panel:latest | ||
# 最新beta版本 | ||
docker pull hslr/sun-panel:beta | ||
# 其他指定版本(版本号前不要带有 'v') | ||
docker pull hslr/sun-panel:1.4.0 | ||
docker pull hslr/sun-panel:1.4.0-beta24-02-20 | ||
``` | ||
|
||
### 3. 群晖或者其他可视化操作的 | ||
直接选择要使用的标签进行拉取,新建容器运行,挂载路径要保证与旧版本一致。如果不支持筛选标签按下面命令行方式运行 | ||
|
||
### 4. 命令行运行(挂载目录与旧版本一致) | ||
建议新建容器运行,如遇问题可以及时恢复, | ||
```sh | ||
docker run -d --restart=always -p 3002:3002 \ | ||
-v ~/docker_data/sun-panel/conf:/app/conf \ | ||
--name sun-panel \ | ||
hslr/sun-panel:latest | ||
``` | ||
将上面命令中 `latest` 替换成任意已有的版本标签即可,其他参数按自身需求修改 | ||
|
||
|
||
## 二进制版本 | ||
|
||
::: tip | ||
前往Github [Releases](https://github.com/hslr-s/sun-panel/releases) 下载二进制文件 | ||
::: | ||
|
||
下载后,将压缩包中的 `web` 文件夹和 `可执行二进制文件`,直接覆盖后再次运行即可。 | ||
|
||
---- | ||
相关参考:<a href="../usage/quick_deploy">部署教程</a> | <a href="https://www.bilibili.com/video/BV1ke411y7B5" target="_blank">[Bilibili] Beta更新视频教程</a> | <a href="https://youtu.be/wRo-azoAbsQ?si=ZNSKm89bx0yq5Puw" target="_blank">[YouTube] Beta更新视频教程</a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1 @@ | ||
::: danger 谨慎更新 | ||
Beta版本是正式版本前的测试版本,极有可能有严重的bug,**升级请务必备份!!!** | ||
|
||
docker里面 `latest` 标签是正式版本或者稳定的beta版本,不会更新不稳定的beta版本。 | ||
|
||
`beta` 或者 `[主版本号]-beta日期` 示例:`1.4.0-beta24-02-20` 组成,均为beta版本。 | ||
|
||
更新完成如果没有任何效果记得[清除浏览器缓存](https://blog.csdn.net/m0_46156566/article/details/108519629)) | ||
::: | ||
|
||
|
||
## docker 版本 | ||
|
||
### 1. 进入到DockerHub的 [Sun-Panel项目首页](https://hub.docker.com/r/hslr/sun-panel/tags),beta版本在标签行会有beta标识+日期 | ||
|
||
![](/images/update_log/docker_hub_beta.png) | ||
|
||
### 2. 复制指令下载(请注意不是latest) | ||
|
||
示例 | ||
``` | ||
# 最新beta版本 | ||
docker pull hslr/sun-panel:beta | ||
# beta24-02-20 换成指定版本号 | ||
docker pull hslr/sun-panel:1.4.0-beta24-02-20 | ||
``` | ||
|
||
### 3. 群晖或者其他可视化操作的 | ||
直接选择带有 `beta` 或 `beta+日期` 的标签拉取,新建容器运行,不支持筛选标签按下面命令行方式运行 | ||
|
||
### 4. 命令行运行(挂载目录与正式版一致) | ||
建议新建容器运行,如遇问题可以及时恢复, | ||
```sh | ||
docker run -d --restart=always -p 3002:3002 \ | ||
-v ~/docker_data/sun-panel/conf:/app/conf \ | ||
--name sun-panel \ | ||
hslr/sun-panel:beta | ||
``` | ||
将上面命令中`hslr/sun-panel:beta`替换成最新beta版本的标签即可,其他参数按自身需求修改 | ||
|
||
|
||
## 二进制版本 | ||
|
||
::: tip | ||
前往Github [Releases](https://github.com/hslr-s/sun-panel/releases) 下载二进制文件 | ||
::: | ||
|
||
下载后,将压缩包中的 `web` 文件夹和 `可执行二进制文件`,直接覆盖后再次运行即可。 | ||
|
||
---- | ||
完整运行参考:<a href="../usage/quick_deploy">部署教程</a> | <a href="https://www.bilibili.com/video/BV1ke411y7B5" target="_blank">B站Beta更新视频教程</a> | ||
# 请移步[更新说明](./update) |