Skip to content

Commit d559f75

Browse files
chivehaochivehao
committed
build: archive v0.17 docs
1 parent 403596a commit d559f75

Some content is hidden

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

55 files changed

+2918
-9
lines changed

‎docs/plugins/plugin-mikan.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,28 @@ description: 蜜柑计划插件说明（不推荐使用）
1111

1212
- 官网：<https://mikanime.tv/>
1313

14-
## 不推荐理由
1514

16-
个人不建议使用。这个插件实在是有点难用，
17-
主要问题还是在和第三方Qbittorrent交互上，这里涉及的用户容器权限问题比较复杂，
18-
可能等未来 ikaros 通过插件实现了 BT下载，这个插件用起来才比较方便。
15+
## QBittorrent
1916

17+
:::tip
18+
您的qbittorrent的pid和uid需要配置为有访问ikaros宿主机目录的用户uid和pid，如果是ubuntu，直接配置成root的0，如果是nas，你得先去获取下nas对应有目录权限的用户的uid和pid。
19+
20+
您还需要给qbittorrent容器挂载一个ikaros的缓存目录：
21+
22+
{您Ikaros容器在主机上的缓存目录绝对路径}:/root/.ikaros/caches
23+
:::
2024

2125
## 配置
2226

27+
28+
29+
2330
您可以在后台配置蜜柑计划的RSS和`Qbitorrent`的地址
2431

2532
![Ikaros Console Plugin Config](/img/plugins-plugin-mikan/Snipaste_2023-07-30_15-48-14.png)
2633

27-
:::tip
28-
这里的qbittorrent的ip是docker的虚拟ip。这个和部署方式有关，需要保证能够连通qbittorrent, 您可以通过部署一个portainer在ikaros的network里添加你的qbittorrent容器，这样就有了一个虚拟ip。
29-
:::
34+
35+
3036

3137
## 功能说明
3238

‎i18n/en/docusaurus-plugin-content-docs/version-0.17.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"version.label": {
3+
"message": "0.17",
4+
"description": "The label for version 0.17"
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+
}

‎i18n/en/docusaurus-plugin-content-docs/version-0.17/about.md

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.

‎i18n/en/docusaurus-plugin-content-docs/version-0.17/getting-started/install/android-app.md

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+
:::

‎i18n/en/docusaurus-plugin-content-docs/version-0.17/getting-started/install/docker-compose.md

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,219 @@
1+
---
2+
title: Deploying with Docker Compose
3+
description: Deploying with Docker Compose
4+
---
5+
6+
import DockerArgs from "./slots/docker-args.md"
7+
8+
:::info
9+
Before proceeding, we recommend reading the [Introduction](../prepare.md), which can quickly help you understand Ikaros.
10+
:::
11+
12+
## Setting Up the Environment
13+
14+
- Docker Installation Guide: <https://docs.docker.com/engine/install/>
15+
- Docker Compose Installation Guide: <https://docs.docker.com/compose/install/>
16+
17+
:::tip
18+
We recommend installing Docker and Docker Compose following the official Docker documentation, as the Docker version in the software repositories of some Linux distributions may be outdated.
19+
:::
20+
21+
## Creating Container Group
22+
23+
Available Docker images for Ikaros:
24+
25+
- [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)
26+
27+
:::info Note
28+
Currently, Ikaros has not updated the Docker image with the `latest` tag, mainly because no official version has been released yet. We recommend using specific version tags, such as `ikarosrun/ikaros:v0.11.5`.
29+
30+
- `ikarosrun/ikaros:v0.11.5`: Represents the latest available image. A new image is built for each release based on GitHub tags.
31+
- `ikarosrun/ikaros:dev`: Represents the image in development. It is not recommended for use, as it is rebuilt and overwritten with each merged Pull Request into the main branch.
32+
33+
Subsequent documentation will use `ikarosrun/ikaros:v0.11.5` as an example.
34+
:::
35+
36+
1. Create a folder anywhere in the system. This document uses `~/ikaros` as an example.
37+
38+
```bash
39+
mkdir ~/ikaros && cd ~/ikaros
40+
```
41+
:::info
42+
Note: In subsequent operations, all data generated by Ikaros will be saved in this directory. Please keep it safe.
43+
:::
44+
45+
2. Create `docker-compose.yaml`
46+
47+
This document provides Docker Compose configuration files for two scenarios. Please choose one based on your needs.
48+
49+
1. Create an instance of Ikaros + PostgreSQL:
50+
51+
```yaml {24-34,51} title="~/ikaros/docker-compose.yaml"
52+
version: "3"
53+
services:
54+
# ikaros
55+
ikaros:
56+
image: ikarosrun/ikaros:v0.11.5
57+
container_name: ikaros
58+
restart: on-failure:3
59+
depends_on:
60+
ikaros_database:
61+
condition: service_healthy
62+
networks:
63+
ikaros_networks:
64+
volumes:
65+
- ./:/root/.ikaros
66+
ports:
67+
- "9999:9999"
68+
healthcheck:
69+
test: [ "CMD", "curl", "-f", "http://localhost:9999/actuator/health"]
70+
interval: 30s
71+
timeout: 5s
72+
retries: 5
73+
start_period: 30s
74+
environment:
75+
- LANG=C.UTF-8
76+
- LC_ALL=C.UTF-8
77+
- TZ=Asia/Shanghai
78+
command:
79+
- --logging.charset.console=UTF-8
80+
- --logging.charset.file=UTF-8
81+
# log level for package, such as INFO or DEBUG
82+
- --logging.level.run.ikaros.server=INFO
83+
- --logging.level.run.ikaros.plugin=INFO
84+
- --logging.level.run.ikaros.jellyfin=INFO
85+
- --sun.jnu.encoding=UTF-8
86+
- --spring.r2dbc.url=r2dbc:pool:postgresql://ikaros_database/ikaros
87+
- --spring.r2dbc.username=ikaros
88+
# Make sure the password for PostgreSQL matches the value of the POSTGRES_PASSWORD variable below.
89+
- --spring.r2dbc.password=openpostgresql
90+
- --spring.sql.init.platform=postgresql
91+
# Initial superuser username
92+
- --ikaros.security.initializer.master-username=tomoki
93+
# Initial superuser password
94+
- --ikaros.security.initializer.master-password=tomoki
95+
96+
# ikaros database
97+
ikaros_database:
98+
image: postgres:latest
99+
container_name: ikaros_database
100+
restart: on-failure:3
101+
networks:
102+
ikaros_networks:
103+
volumes:
104+
- ./database:/var/lib/postgresql/data
105+
healthcheck:
106+
test: [ "CMD", "pg_isready" ]
107+
interval: 10s
108+
timeout: 5s
109+
retries: 5
110+
environment:
111+
- POSTGRES_DB=ikaros
112+
- POSTGRES_USER=ikaros
113+
- POSTGRES_PASSWORD=openpostgresql
114+
115+
networks:
116+
ikaros_networks:
117+
driver: bridge
118+
```
119+
120+
2. Create Ikaros instance only (using the default H2 database, **not recommended for production environment, suggested for experience and testing only**):
121+
122+
```yaml {19-24} title="~/ikaros/docker-compose.yaml"
123+
version: "3"
124+
services:
125+
# ikaros
126+
ikaros:
127+
image: ikarosrun/ikaros:v0.11.5
128+
container_name: ikaros
129+
restart: on-failure:3
130+
networks:
131+
ikaros_networks:
132+
volumes:
133+
- ./:/root/.ikaros
134+
ports:
135+
- "9999:9999"
136+
healthcheck:
137+
test: [ "CMD", "curl", "-f", "http://localhost:9999/actuator/health"]
138+
interval: 30s
139+
timeout: 5s
140+
retries: 5
141+
start_period: 30s
142+
environment:
143+
- LANG=C.UTF-8
144+
- LC_ALL=C.UTF-8
145+
- TZ=Asia/Shanghai
146+
command:
147+
- --logging.charset.console=UTF-8
148+
- --logging.charset.file=UTF-8
149+
- --logging.level.run.ikaros.server=INFO
150+
- --logging.level.run.ikaros.plugin=INFO
151+
- --logging.level.run.ikaros.jellyfin=INFO
152+
- --sun.jnu.encoding=UTF-8
153+
# Initial superuser username
154+
- --ikaros.security.initializer.master-username=tomoki
155+
# Initial superuser password
156+
- --ikaros.security.initializer.master-password=tomoki
157+
158+
networks:
159+
ikaros_networks:
160+
driver: bridge
161+
```
162+
163+
Parameter Details:
164+
165+
<DockerArgs />
166+
167+
3. Start the Ikaros service
168+
169+
```bash
170+
docker-compose up -d
171+
```
172+
173+
View logs in real-time:
174+
175+
```bash
176+
docker-compose logs -f ikaros
177+
```
178+
179+
4. Access the Ikaros management page by visiting `/console` in your browser. The username and password are the ones set in the `docker-compose.yaml` file as `master-username` and `master-password`.
180+
181+
:::tip
182+
If not started with these parameters, the default username is `tomoki`, and the password will be printed in the logs (printed only on the first run).
183+
:::
184+
185+
## Updating Container Group
186+
187+
1. Stop the running container group.
188+
189+
```bash
190+
cd ~/ikaros && docker-compose down
191+
```
192+
193+
2. Backup Data (Important)
194+
195+
```bash
196+
cp -r ~/ikaros ~/ikaros.archive
197+
```
198+
199+
> It's worth noting that the `ikaros.archive` filename doesn't necessarily have to follow the naming convention in this document. This is just an example.
200+
201+
202+
3. Update the Ikaros service
203+
204+
Modify the image version configured in `docker-compose.yaml`.
205+
206+
```yaml {3}
207+
services:
208+
ikaros:
209+
image: ikarosrun/ikaros:v0.11.5
210+
container_name: ikaros
211+
```
212+
213+
```bash
214+
docker-compose pull ikaros
215+
```
216+
217+
```bash
218+
docker-compose up -d
219+
```

0 commit comments

Comments
 (0)