Skip to content
This repository was archived by the owner on Aug 25, 2025. It is now read-only.

Commit df88c8e

Browse files
authored
chore(docs): fix the copyright issue of the document and change the docker image address to the dockerhub address (#35)
* fixed Copyright view bugs * Modify dockeru Link to dockerhub source * Update docker.md * Modify docker Link to dockerhub source * Update theme.ts * fixed docker version
1 parent 9c28352 commit df88c8e

File tree

4 files changed

+25
-23
lines changed

4 files changed

+25
-23
lines changed

docs/.vuepress/public/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: '3.3'
22
services:
33
openlist:
4-
image: 'openlistteam/openlist:latest'
4+
image: 'openlistteam/openlist:beta'
55
container_name: openlist
66
volumes:
77
- './:/opt/openlist/data'

docs/.vuepress/theme.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ export default hopeTheme(
2020
"/": {
2121
navbar: navbar.en,
2222
sidebar: sidebar.en,
23-
footer: '',
23+
copyright: false,
24+
footer: 'AGPL-3.0 Licensed | Copyright © 2022-present The OpenList Team',
2425
displayFooter: true,
2526
},
2627

@@ -30,7 +31,8 @@ export default hopeTheme(
3031
"/zh/": {
3132
navbar: navbar.zh,
3233
sidebar: sidebar.zh,
33-
footer: '',
34+
copyright: false,
35+
footer: 'AGPL-3.0 Licensed | Copyright © 2022-present The OpenList Team',
3436
displayFooter: true,
3537
},
3638
},

docs/guide/install/docker.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Note: The official OpenList Docker image has not yet been released. The Docker i
2525
#### **docker cli**
2626

2727
```bash
28-
docker run -d --restart=unless-stopped -v /etc/openlist:/opt/openlist/data -p 5244:5244 -e PUID=0 -e PGID=0 -e UMASK=022 --name="openlist" ghcr.io/openlistteam/openlist:latest
28+
docker run -d --restart=unless-stopped -v /etc/openlist:/opt/openlist/data -p 5244:5244 -e PUID=0 -e PGID=0 -e UMASK=022 --name="openlist" openlistteam/openlist:bata
2929
```
3030

3131
#### **docker compose**
@@ -34,7 +34,7 @@ docker run -d --restart=unless-stopped -v /etc/openlist:/opt/openlist/data -p 52
3434
version: '3.3'
3535
services:
3636
openlist:
37-
image: 'ghcr.io/openlistteam/openlist:beta'
37+
image: 'openlistteam/openlist:beta'
3838
container_name: openlist
3939
volumes:
4040
- '/etc/openlist:/opt/openlist/data'
@@ -59,7 +59,7 @@ services:
5959

6060
#### **Image Versions**
6161

62-
Stable version: `ghcr.io/openlistteam/openlist:latest` or specify beta version, such as `ghcr.io/openlistteam/openlist:beta` (latest is not online)
62+
Stable version: `openlistteam/openlist:latest` or specify beta version, such as `openlistteam/openlist:beta` (latest is not online)
6363

6464
Latest image version, please refer to https://hub.docker.com/r/openlistteam/openlist/tags
6565

@@ -73,7 +73,7 @@ Pre-installed environment image suffix:
7373
| `ffmpeg` | Pre-installed FFmpeg image for generating thumbnail for local storage |
7474
| `aria2` | Pre-installed aria2 image for offline downloading. |
7575

76-
You can append a suffix using the `-` symbol after any of the mirror tags to switch to an image with the corresponding environment. For example, `openlistteam/openlist:latest-aio` `openlistteam/openlist:beta-aria2` `openlistteam/openlist:v3.40.0-ffmpeg`
76+
You can append a suffix using the `-` symbol after any of the mirror tags to switch to an image with the corresponding environment. For example, `openlistteam/openlist:latest-aio` `openlistteam/openlist:latest-aria2` `openlistteam/openlist:latest-ffmpeg`(latest is not online)
7777

7878
If the thumbnail generation function still does not work when using the pre-installed ffmpeg, please confirm:
7979

@@ -114,7 +114,7 @@ docker exec -it openlist ./openlist admin set NEW_PASSWORD
114114
1. docker ps -a #View the container (find the ID of the Alist container)
115115
2. docker stop ID #Stop Alist running, otherwise it cannot be deleted (this time the ID of the Alist container is d429749a6e69, it is different for each installation)
116116
3. docker rm ID #Delete the Alist container (the data is still there as long as you don't delete it manually)
117-
4. docker pull openlistteam/openlist:latest
117+
4. docker pull openlistteam/openlist:beta
118118
5. [Enter the installation command and click to view](#docker-cli)
119119
6. The update is complete, go and have a look.. It's that simple
120120

@@ -129,12 +129,12 @@ docker exec -it openlist ./openlist admin set NEW_PASSWORD
129129

130130
:::
131131

132-
Q: My version is v3.x.x and I cannot upgrade to the latest version. `docker pull ghcr.io/openlistteam/openlist:latest` does not work to pull the latest version. After changing to docker-compose, it is still version 3.x.x
132+
Q: My version is v3.x.x and I cannot upgrade to the latest version. `docker pull openlistteam/openlist:latest` does not work to pull the latest version. After changing to docker-compose, it is still version 3.x.x
133133

134134
A: The reason is that your docker has set up a mirror, and the latest version cannot be updated from the mirror, so modify /etc/docker/daemon.json and delete "registry-mirrors": ["mirror accelerator address"]
135135

136136
- If deletion doesn’t work, you can consider replacing it with a `mirror acceleration address`
137-
- Or simple and rude: when downloading, replace `ghcr.io/openlistteam/openlist:latest` with `ghcr.io/openlistteam/openlist:v3.16.3` (specify the version, the latest when writing the tutorial is 3.16.3)
137+
- Or simple and rude: when downloading, replace `openlistteam/openlist:latest` with `openlistteam/openlist:v4.0.0` (specify the version, the latest when writing the tutorial is 4.0.0)
138138

139139
### **Compile Image**
140140

@@ -145,13 +145,13 @@ Install Docker, clone the repository, then navigate to the root directory of the
145145
@tab basic
146146

147147
```bash
148-
docker build -t ghcr.io/openlistteam/openlist:latest .
148+
docker build -t openlistteam/openlist:beta .
149149
```
150150

151151
@tab build-arg
152152

153153
```bash
154-
docker build -t ghcr.io/openlistteam/openlist:latest-ffmpeg --build-arg INSTALL_FFMPEG=true .
154+
docker build -t openlistteam/openlist:beta-ffmpeg --build-arg INSTALL_FFMPEG=true .
155155
```
156156

157157
:::

docs/zh/guide/install/docker.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ star: true
2525
#### **docker cli**
2626

2727
```bash
28-
docker run -d --restart=unless-stopped -v /etc/openlist:/opt/openlist/data -p 5244:5244 -e PUID=0 -e PGID=0 -e UMASK=022 --name="openlist" ghcr.io/openlistteam/openlist:latest
28+
docker run -d --restart=unless-stopped -v /etc/openlist:/opt/openlist/data -p 5244:5244 -e PUID=0 -e PGID=0 -e UMASK=022 --name="openlist" openlistteam/openlist:beta
2929
```
3030

3131
#### **docker compose**
@@ -34,7 +34,7 @@ docker run -d --restart=unless-stopped -v /etc/openlist:/opt/openlist/data -p 52
3434
version: '3.3'
3535
services:
3636
openlist:
37-
image: 'ghcr.io/openlistteam/openlist:beta'
37+
image: 'openlistteam/openlist:beta'
3838
container_name: openlist
3939
volumes:
4040
- '/etc/openlist:/opt/openlist/data'
@@ -59,11 +59,11 @@ services:
5959

6060
#### **镜像版本**
6161

62-
稳定版:`ghcr.io/openlistteam/openlist:latest` 或指定本版,如 `ghcr.io/openlistteam/openlist:beta`(Latest暂未上线)
62+
稳定版:`openlistteam/openlist:latest` 或指定本版,如 `openlistteam/openlist:beta`(Latest暂未上线)
6363

6464
最新镜像版本,请参阅 https://hub.docker.com/r/openlistteam/openlist/tags
6565

66-
开发版:`ghcr.io/openlistteam/openlist:beta`
66+
开发版:`openlistteam/openlist:beta`
6767

6868
预装环境镜像后缀:
6969

@@ -73,7 +73,7 @@ services:
7373
| `ffmpeg` | 预装 ffmpeg 的镜像,用于本地存储缩略图 |
7474
| `aria2` | 预装 aria2 的镜像,用于离线下载 |
7575

76-
你可以在上述任意镜像标签后面,使用 `-` 符号附加后缀以切换到附带环境的镜像。如 `ghcr.io/openlistteam/openlist:latest-aio` `ghcr.io/openlistteam/openlist:beta-aria2` `ghcr.io/openlistteam/openlist:v3.40.0-ffmpeg`
76+
你可以在上述任意镜像标签后面,使用 `-` 符号附加后缀以切换到附带环境的镜像。如 `openlistteam/openlist:latest-aio` `openlistteam/openlist:latest-aria2` `openlistteam/openlist:latest-ffmpeg`(Latest暂未上线)
7777

7878
如果使用预装 ffmpeg 镜像缩略图功能仍无法使用,请确认:
7979

@@ -120,7 +120,7 @@ docker exec -it openlist ./openlist admin set NEW_PASSWORD
120120

121121
3. docker rm ID #删除Alist容器(数据还在只要你不手动删除)
122122

123-
4. docker pull ghcr.io/openlistteam/openlist:latest
123+
4. docker pull openlistteam/openlist:beta
124124

125125
5. [输入安装命令点击查看](#docker-cli)
126126

@@ -137,12 +137,12 @@ docker exec -it openlist ./openlist admin set NEW_PASSWORD
137137

138138
:::
139139

140-
Q:我的版本是v3.x.x 怎么也升级不到最新版 `docker pull ghcr.io/openlistteam/openlist:latest`拉取最新不行 改成docker-compose安装还是3.x.x版本
140+
Q:我的版本是v3.x.x 怎么也升级不到最新版 `docker pull openlistteam/openlist:beta`拉取最新不行 改成docker-compose安装还是3.x.x版本
141141

142142
A:原因是你的docker设置了镜像,从镜像更新不到最新版本,改一下/etc/docker/daemon.json,删除"registry-mirrors": ["镜像加速器地址"]
143143

144144
- 删除若不行,可以考虑更换一个`镜像加速地址`
145-
- 或者简单粗暴:下载时将`ghcr.io/openlistteam/openlist:latest` 替换为`ghcr.io/openlistteam/openlist:v3.16.3`(指定版本,写教程时最新的是3.16.3
145+
- 或者简单粗暴:下载时将`openlistteam/openlist:beta` 替换为`openlistteam/openlist:v4.0.0`(指定版本,写教程时最新的是4.0.0
146146

147147
### **编译镜像**
148148

@@ -153,13 +153,13 @@ A:原因是你的docker设置了镜像,从镜像更新不到最新版本,
153153
@tab basic
154154

155155
```bash
156-
docker build -t ghcr.io/openlistteam/openlist:latest .
156+
docker build -t openlistteam/openlist:beta .
157157
```
158158

159159
@tab build-arg
160160

161161
```bash
162-
docker build -t ghcr.io/openlistteam/openlist:latest-ffmpeg --build-arg INSTALL_FFMPEG=true .
162+
docker build -t openlistteam/openlist:beta-ffmpeg --build-arg INSTALL_FFMPEG=true .
163163
```
164164

165165
:::
@@ -170,4 +170,4 @@ docker build -t ghcr.io/openlistteam/openlist:latest-ffmpeg --build-arg INSTALL_
170170
| | 说明 |
171171
|:----------------------|-----------|
172172
| `INSTALL_FFMPEG=true` | 安装 ffmpeg |
173-
| `INSTALL_ARIA2=true` | 安装 aria2 |
173+
| `INSTALL_ARIA2=true` | 安装 aria2 |

0 commit comments

Comments
 (0)