Skip to content

Commit 0219ee3

Browse files
committed
docs: pubilsh version 1.0
1 parent a614ce8 commit 0219ee3

59 files changed

Lines changed: 2969 additions & 26 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/getting-started/install/docker-compose.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ import DockerArgs from "./slots/docker-args.md"
2525
- [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)
2626

2727
:::info 注意
28-
目前 Ikaros 并未更新 Docker 的 latest 标签镜像,主要因为 暂未发布正式版本。我们推荐使用固定版本的标签,比如 `ikarosrun/ikaros:v0.21.0`
2928

30-
- `ikarosrun/ikaros:v0.21.0`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
29+
- `ikarosrun/ikaros:latest`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
3130
- `ikarosrun/ikaros:dev`:表示开发中的镜像,不推荐使用,每次Pull Request合并到主分支都会构建并覆盖该镜像。。
3231

33-
后续文档以 `ikarosrun/ikaros:v0.21.0` 为例。
32+
后续文档以 `ikarosrun/ikaros:latest` 为例。
3433
:::
3534

3635
1. 在系统任意位置创建一个文件夹,此文档以 `~/ikaros` 为例。
@@ -54,7 +53,7 @@ import DockerArgs from "./slots/docker-args.md"
5453
services:
5554
# ikaros
5655
ikaros:
57-
image: ikarosrun/ikaros:v0.21.0
56+
image: ikarosrun/ikaros:latest
5857
container_name: ikaros
5958
restart: on-failure:3
6059
depends_on:
@@ -132,7 +131,7 @@ import DockerArgs from "./slots/docker-args.md"
132131
services:
133132
# ikaros
134133
ikaros:
135-
image: ikarosrun/ikaros:v0.21.0
134+
image: ikarosrun/ikaros:latest
136135
container_name: ikaros
137136
restart: on-failure:3
138137
networks:
@@ -216,7 +215,7 @@ import DockerArgs from "./slots/docker-args.md"
216215
```yaml {3}
217216
services:
218217
ikaros:
219-
image: ikarosrun/ikaros:v0.21.0
218+
image: ikarosrun/ikaros:latest
220219
container_name: ikaros
221220
```
222221

docs/getting-started/install/docker.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@ import DockerArgs from "./slots/docker-args.md"
3030
- [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)
3131

3232
:::info 注意
33-
目前 Ikaros 并未更新 Docker 的 latest 标签镜像,主要因为 暂未发布正式版本。我们推荐使用固定版本的标签,比如 `ikarosrun/ikaros:v0.21.0`
3433

35-
- `ikarosrun/ikaros:v0.21.0`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
34+
- `ikarosrun/ikaros:latest`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
3635
- `ikarosrun/ikaros:dev`:表示开发中的镜像,不推荐使用,每次Pull Request合并到主分支都会构建并覆盖该镜像。。
3736

38-
后续文档以 `ikarosrun/ikaros:v0.21.0` 为例。
37+
后续文档以 `ikarosrun/ikaros:latest` 为例。
3938
:::
4039

4140
1. 创建容器
@@ -46,7 +45,7 @@ import DockerArgs from "./slots/docker-args.md"
4645
--name ikaros \
4746
-p 9999:9999 \
4847
-v ~/.ikaros:/root/.ikaros \
49-
ikarosrun/ikaros:v0.21.0 \
48+
ikarosrun/ikaros:latest \
5049
--ikaros.security.initializer.master-username=tomoki \
5150
--ikaros.security.initializer.master-password=tomoki
5251
```
@@ -76,7 +75,7 @@ import DockerArgs from "./slots/docker-args.md"
7675
1. 拉取新版本镜像(请选择最新的标签替换下方的`v0.21.0`)
7776

7877
```bash
79-
docker pull ikarosrun/ikaros:v0.21.0
78+
docker pull ikarosrun/ikaros:latest
8079
```
8180

8281
2. 停止运行中的容器
@@ -104,7 +103,7 @@ import DockerArgs from "./slots/docker-args.md"
104103
--name ikaros \
105104
-p 9999:9999 \
106105
-v ~/.ikaros:/root/.ikaros \
107-
ikarosrun/ikaros:v0.21.0 \
106+
ikarosrun/ikaros:latest \
108107
--ikaros.security.initializer.master-username=tomoki \
109108
--ikaros.security.initializer.master-password=tomoki
110109
```

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ docker run \
4646
--name ikaros \
4747
-p 9999:9999 \
4848
-v ~/.ikaros:/root/.ikaros \
49-
ikarosrun/ikaros:v0.21.0 \
49+
ikarosrun/ikaros:latest \
5050
--ikaros.security.initializer.master-username=tomoki \
5151
--ikaros.security.initializer.master-password=tomoki
5252
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: 附件驱动
3+
description: 附件驱动管理相关功能说明
4+
---
5+
6+
## 说明
7+
8+
- 附件驱动目前只支持挂载本地目录,给插件的拓展接口这块Console还没弄好
9+
- 驱动新建后默认是禁用的,需要手动启用
10+
- 驱动启用后,需进入对应挂载的附件目录刷新下获取最新的目录和文件数据
11+
12+
## 页面入口
13+
14+
`附件`页的上方`驱动`按钮跳转
15+
16+
17+

docs/user-guide/faq.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,23 @@ description: 使用上的常见问题
1919

2020
### 如何导入已经存在的资源
2121

22-
对于已经存在的资源文件,可以借助本地导入插件
23-
关于资源导入,可以先按照以下步骤来
24-
25-
1. 安装本地导入插件并启动
26-
2. 进nas的web控制台文件管理,将你已经存在的资源,移动到ikaros的links目录
27-
3. 进ikaros后台,停止本地导入插件,再启动,这里会卡一段时间,因为ikaros在将links目录里的文件全部导入文件管理,默认是软链接,软链接失败会复制
28-
4 过段时间,等ikaros后台能正常访问了,代表导入结束了,能在ikaros后台看到对应的文件
29-
5 进nas控制台文件管理,将links目录文件移动会原来的位置。
30-
31-
资源导入结束,后续是:
32-
6. ikaros后台添加对应条目
33-
7. 进入条目详情进行资源绑定
22+
~~对于已经存在的资源文件,可以借助本地导入插件~~
23+
~~关于资源导入,可以先按照以下步骤来~~
24+
25+
~~1. 安装本地导入插件并启动~~
26+
27+
~~2. 进nas的web控制台文件管理,将你已经存在的资源,移动到ikaros的links目录~~
28+
29+
~~3. 进ikaros后台,停止本地导入插件,再启动,这里会卡一段时间,因为ikaros在将links目录里的文件全部导入文件管理,默认是软链接,软链接失败会复制~~
30+
31+
~~4 过段时间,等ikaros后台能正常访问了,代表导入结束了,能在ikaros后台看到对应的文件~~
32+
33+
~~5 进nas控制台文件管理,将links目录文件移动会原来的位置。~~
34+
35+
~~资源导入结束,后续是:~~
36+
37+
~~6. ikaros后台添加对应条目~~
38+
39+
~~7. 进入条目详情进行资源绑定~~
40+
41+
更推荐通过本地目录挂载,手动刷新的方式导入:[附件驱动管理相关功能说明](./attachment_drivers.md)
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"version.label": {
3+
"message": "1.0",
4+
"description": "The label for version 1.0"
5+
},
6+
"sidebar.docsSidebar.category.getting-started": {
7+
"message": "getting-started",
8+
"description": "The label for category getting-started in sidebar docsSidebar"
9+
},
10+
"sidebar.docsSidebar.category.getting-started-install": {
11+
"message": "getting-started-install",
12+
"description": "The label for category getting-started-install in sidebar docsSidebar"
13+
},
14+
"sidebar.docsSidebar.category.user-guide": {
15+
"message": "user-guide",
16+
"description": "The label for category user-guide in sidebar docsSidebar"
17+
},
18+
"sidebar.docsSidebar.category.plugins": {
19+
"message": "plugins",
20+
"description": "The label for category plugins in sidebar docsSidebar"
21+
}
22+
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: About the Documentation
3+
sidebar_label: About
4+
description: Information about this documentation site
5+
---
6+
7+
:::note
8+
This documentation site is built using [Docusaurus](https://docusaurus.io/). Thanks to the [Docusaurus community](https://github.com/facebook/docusaurus) for their contributions.
9+
:::
10+
11+
## Contributing
12+
13+
:::tip
14+
If you find any inaccuracies or have content to add, we welcome your contributions to the documentation.
15+
:::
16+
17+
The current repository for this documentation is located at [ikaros-dev/docs](https://github.com/ikaros-dev/docs). You can fork this repository, make your changes, and submit a pull request for us to review and merge.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Android App (WIP)
3+
description: Native Android App
4+
---
5+
6+
## Introduction
7+
8+
Native app for Android phones.
9+
10+
GitHub: <https://github.com/ikaros-dev/andapp>
11+
12+
:::tip
13+
CI packaging has not been set up yet.
14+
:::

0 commit comments

Comments
 (0)