docs: update 0.14 docs

ikaros-dev · Jul 21, 2024 · c51eb86 · c51eb86
1 parent 474f769
commit c51eb86
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 14 deletions.
diff --git a/blog/pre-release/v0.14.1.md b/blog/pre-release/v0.14.1.md
@@ -0,0 +1,32 @@
+---
+title: v0.14.1
+authors: chivehao
+date: 2024-07-21T02:19
+---
+## GitHub Release
+
+<https://github.com/ikaros-dev/ikaros/releases/tag/v0.14.1>
+
+## 优化
+
+- 默认主题的js问题修复
+- 默认主题的条目详情页添加URL选择的剧集参数
+- 默认主题的条目详情页播放逻辑
+- 后台任务相关接口优化
+- 针对不同尺寸图片的显示优化 #628
+
+## 依赖
+
+- 升级spirngdoc版本到2.5.0
+
+## What's Changed
+* optimzie: default theme subject details html by @chivehao in https://github.com/ikaros-dev/ikaros/pull/623
+* build: upgrade spirngdoc version to 2.5.0 by @chivehao in https://github.com/ikaros-dev/ikaros/pull/624
+* fix: swagger server external url config for https. by @chivehao in https://github.com/ikaros-dev/ikaros/pull/625
+* docs: add annotation for RegexUtils#parseEpisodeSeqByFileName by @chivehao in https://github.com/ikaros-dev/ikaros/pull/626
+* optimize: default theme subject details video player page. by @chivehao in https://github.com/ikaros-dev/ikaros/pull/627
+* feat: task for running in backend by @chivehao in https://github.com/ikaros-dev/ikaros/pull/629
+* feat: 支持条目封面裁剪 by @chivehao in https://github.com/ikaros-dev/ikaros/pull/630
+
+
+**Full Changelog**: https://github.com/ikaros-dev/ikaros/compare/v0.14.0...v0.14.1
diff --git a/docs/getting-started/install/docker-compose.md b/docs/getting-started/install/docker-compose.md
@@ -25,12 +25,12 @@ import DockerArgs from "./slots/docker-args.md"
 - [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)
 
 :::info 注意
-目前 Ikaros 并未更新 Docker 的 latest 标签镜像，主要因为 暂未发布正式版本。我们推荐使用固定版本的标签，比如 `ikarosrun/ikaros:v0.13.0` 。
+目前 Ikaros 并未更新 Docker 的 latest 标签镜像，主要因为 暂未发布正式版本。我们推荐使用固定版本的标签，比如 `ikarosrun/ikaros:v0.14.1` 。
 
-- `ikarosrun/ikaros:v0.13.0`：表示最新的可用镜像，每次发布时都会根据GitHub的标签构建一个新的镜像
+- `ikarosrun/ikaros:v0.14.1`：表示最新的可用镜像，每次发布时都会根据GitHub的标签构建一个新的镜像
 - `ikarosrun/ikaros:dev`：表示开发中的镜像，不推荐使用，每次Pull Request合并到主分支都会构建并覆盖该镜像。。
 
-后续文档以 `ikarosrun/ikaros:v0.13.0` 为例。
+后续文档以 `ikarosrun/ikaros:v0.14.1` 为例。
 :::
 
 1. 在系统任意位置创建一个文件夹，此文档以 `~/ikaros` 为例。
@@ -54,7 +54,7 @@ import DockerArgs from "./slots/docker-args.md"
     services:
         # ikaros
         ikaros:
-            image: ikarosrun/ikaros:v0.13.0
+            image: ikarosrun/ikaros:v0.14.1
             container_name: ikaros
             restart: on-failure:3
             depends_on:
@@ -95,6 +95,8 @@ import DockerArgs from "./slots/docker-args.md"
               - --spring.flyway.locations=classpath:db/postgresql/migration
               - --spring.flyway.user=ikaros
               - --spring.flyway.password=openpostgresql
+              # ikaros
+              - --ikaros.external-url=http(s)://domain.com
               # 初始化的超级管理员用户名
               - --ikaros.security.initializer.master-username=tomoki
               # 初始化的超级管理员密码
@@ -131,7 +133,7 @@ import DockerArgs from "./slots/docker-args.md"
     services:
        # ikaros
       ikaros:
-          image: ikarosrun/ikaros:v0.13.0
+          image: ikarosrun/ikaros:v0.14.1
           container_name: ikaros
           restart: on-failure:3
           networks:
@@ -159,6 +161,8 @@ import DockerArgs from "./slots/docker-args.md"
             - --logging.level.run.ikaros.plugin=INFO
             - --logging.level.run.ikaros.jellyfin=INFO
             - --sun.jnu.encoding=UTF-8
+            # ikaros
+            - --ikaros.external-url=http(s)://domain.com
             # 初始化的超级管理员用户名
             - --ikaros.security.initializer.master-username=tomoki
             # 初始化的超级管理员密码
@@ -214,7 +218,7 @@ import DockerArgs from "./slots/docker-args.md"
   ```yaml {3}
   services:
     ikaros:
-      image: ikarosrun/ikaros:v0.13.0
+      image: ikarosrun/ikaros:v0.14.1
       container_name: ikaros
   ```
 

diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md
@@ -30,12 +30,12 @@ import DockerArgs from "./slots/docker-args.md"
 - [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)
 
 :::info 注意
-目前 Ikaros 并未更新 Docker 的 latest 标签镜像，主要因为 暂未发布正式版本。我们推荐使用固定版本的标签，比如 `ikarosrun/ikaros:v0.13.0` 。
+目前 Ikaros 并未更新 Docker 的 latest 标签镜像，主要因为 暂未发布正式版本。我们推荐使用固定版本的标签，比如 `ikarosrun/ikaros:v0.14.1` 。
 
-- `ikarosrun/ikaros:v0.13.0`：表示最新的可用镜像，每次发布时都会根据GitHub的标签构建一个新的镜像
+- `ikarosrun/ikaros:v0.14.1`：表示最新的可用镜像，每次发布时都会根据GitHub的标签构建一个新的镜像
 - `ikarosrun/ikaros:dev`：表示开发中的镜像，不推荐使用，每次Pull Request合并到主分支都会构建并覆盖该镜像。。
 
-后续文档以 `ikarosrun/ikaros:v0.13.0` 为例。
+后续文档以 `ikarosrun/ikaros:v0.14.1` 为例。
 :::
 
 1. 创建容器
@@ -46,7 +46,7 @@ import DockerArgs from "./slots/docker-args.md"
         --name ikaros \
         -p 9999:9999 \
         -v ~/.ikaros:/root/.ikaros \
-        ikarosrun/ikaros:v0.13.0 \
+        ikarosrun/ikaros:v0.14.1 \
         --ikaros.security.initializer.master-username=tomoki \
         --ikaros.security.initializer.master-password=tomoki
     ```
@@ -73,10 +73,10 @@ import DockerArgs from "./slots/docker-args.md"
 
 ## 升级版本
 
-1. 拉取新版本镜像(请选择最新的标签替换下方的`v0.13.0`)
+1. 拉取新版本镜像(请选择最新的标签替换下方的`v0.14.1`)
 
   ```bash
-  docker pull ikarosrun/ikaros:v0.13.0
+  docker pull ikarosrun/ikaros:v0.14.1
   ```
 
 2. 停止运行中的容器
@@ -104,7 +104,7 @@ import DockerArgs from "./slots/docker-args.md"
         --name ikaros \
         -p 9999:9999 \
         -v ~/.ikaros:/root/.ikaros \
-        ikarosrun/ikaros:v0.13.0 \
+        ikarosrun/ikaros:v0.14.1 \
         --ikaros.security.initializer.master-username=tomoki \
         --ikaros.security.initializer.master-password=tomoki
     ```
diff --git a/docs/getting-started/install/slots/docker-args.md b/docs/getting-started/install/slots/docker-args.md
@@ -6,6 +6,7 @@
 | `spring.sql.init.platform`                     | 数据库平台名称，支持 `postgresql`、`h2` |
 | `ikaros.security.initializer.master-username` | 初始超级管理员用户名, 默认 `tomoki`                                                             |
 | `ikaros.security.initializer.master-password` | 初始超级管理员密码, 第一次运行程序打印在控日志里                                                               |
+| `ikaros.external-url` | 外部访问地址，比如: https://demo.ikaros.run                                                             |
 
 数据库配置：
 

diff --git a/docs/intro.md b/docs/intro.md
@@ -37,7 +37,7 @@ docker run \
   --name ikaros \
   -p 9999:9999 \
   -v ~/.ikaros:/root/.ikaros \
-  ikarosrun/ikaros:v0.13.0 \
+  ikarosrun/ikaros:v0.14.1 \
   --ikaros.security.initializer.master-username=tomoki \
   --ikaros.security.initializer.master-password=tomoki
 ```