Skip to content

Commit

Permalink
📝 Docs(custom): add support for docker
Browse files Browse the repository at this point in the history
ISSUES CLOSED: #118
  • Loading branch information
Kuingsmile committed Dec 7, 2023
1 parent f901811 commit 2de1a1f
Show file tree
Hide file tree
Showing 4 changed files with 176 additions and 0 deletions.
43 changes: 43 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,46 @@ PicList兼容绝大部分的PicGo插件。然而由于PicList使用了更新的e
- picgo-plugin-auto-delete (已经内置)

欢迎大家测试其他插件,如果有无法使用的插件,欢迎开issue反馈。

## 15. 如何通过Docker运行PicList-core?

### docker run

修改`./piclist`为你自己的路径,修改`piclist123456`为你自己的密钥。

```bash
docker run -d \
--name piclist \
--restart always \
-p 36677:36677 \
-v "./piclist:/root/.piclist" \
kuingsmile/piclist:latest \
node /usr/local/bin/picgo-server -k piclist123456
```

### docker-compose

下载piclist-core仓库的`docker-compose.yml`文件,或者复制以下内容到`docker-compose.yml`文件中:

```yaml
version: '3.3'

services:
node:
image: 'kuingsmile/piclist:latest'
container_name: piclist
restart: always
ports:
- 36677:36677
volumes:
- './piclist:/root/.piclist'
command: node /usr/local/bin/picgo-server -k piclist123456
```
你可以修改`volumes`为你自己的路径,修改`command`为你自己的密钥。

然后运行

```bash
docker-compose up -d
```
43 changes: 43 additions & 0 deletions FAQ_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,46 @@ Known plugins that cannot be used are:
- picgo-plugin-auto-delete (built-in)

Welcome everyone to test other plugins. If there are plugins that cannot be used, please open an issue for feedback.

## 15. How to run PicList-core through Docker?

### docker run

Change the `./piclist` to your own path, and change the `piclist123456` to your own secret key.

```bash
docker run -d \
--name piclist \
--restart always \
-p 36677:36677 \
-v "./piclist:/root/.piclist" \
kuingsmile/piclist:latest \
node /usr/local/bin/picgo-server -k piclist123456
```

### docker-compose

download `docker-compose.yml` from piclist-core repo, or copy the following content to `docker-compose.yml`:

```yaml
version: '3.3'

services:
node:
image: 'kuingsmile/piclist:latest'
container_name: piclist
restart: always
ports:
- 36677:36677
volumes:
- './piclist:/root/.piclist'
command: node /usr/local/bin/picgo-server -k piclist123456
```
You can change the `volumes` to your own path and change the `command` to your own secret key.

Then run:

```bash
docker-compose up -d
```
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ if you want to use PicList-core, please go to [https://github.com/Kuingsmile/Pic
- The PicGo interface has been enhanced, window size restrictions have been unlocked, and some interface layouts have been beautified.
- The installation package for the Mac platform is now signed, addressing the recurring issue on PicGo where the installation package was reported as damaged.

## How to use

### How to use in VScode

Please install my matching plugin [VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist), compared with the vs-picgo plugin, the plugin directly depends on the PicList desktop software, supports a variety of uploads and direct cloud deletion in Vscode and other functions.
Expand Down Expand Up @@ -86,6 +88,49 @@ In the community plugins, search for and install the Image auto upload Plugin. N

![image](https://user-images.githubusercontent.com/96409857/226522718-8378c480-9fb4-4785-87e1-d59808862016.png)

### How to use in docker

#### docker run

Change the `./piclist` to your own path, and change the `piclist123456` to your own secret key.

```bash
docker run -d \
--name piclist \
--restart always \
-p 36677:36677 \
-v "./piclist:/root/.piclist" \
kuingsmile/piclist:latest \
node /usr/local/bin/picgo-server -k piclist123456
```

#### docker-compose

download `docker-compose.yml` from piclist-core repo, or copy the following content to `docker-compose.yml`:

```yaml
version: '3.3'

services:
node:
image: 'kuingsmile/piclist:latest'
container_name: piclist
restart: always
ports:
- 36677:36677
volumes:
- './piclist:/root/.piclist'
command: node /usr/local/bin/picgo-server -k piclist123456
```
You can change the `volumes` to your own path and change the `command` to your own secret key.

Then run:

```bash
docker-compose up -d
```

## Supported platforms

| Platform | Album cloud deletion | Cloud storage management |
Expand Down
45 changes: 45 additions & 0 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ PicList的内核使用的是原版PicGo-Core基础上修改的[PicList-core](htt
- 优化了PicGo的界面,解锁了窗口大小限制,同时美化了部分界面布局
- mac平台安装包已签名,从源头解决了PicGo上的安装包已损坏的日经问题

## 如何使用

### 如何在Vscode中使用

请安装我的配套插件 [VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist),相比于vs-picgo插件,该插件直接依赖于PicList桌面端软件,支持多样上传和直接在Vscode中进行云端删除等功能。
Expand Down Expand Up @@ -86,6 +88,49 @@ MacOS:

![image](https://user-images.githubusercontent.com/96409857/226522718-8378c480-9fb4-4785-87e1-d59808862016.png)

### 如何在Docker中使用

#### docker run

修改`./piclist`为你自己的路径,修改`piclist123456`为你自己的密钥。

```bash
docker run -d \
--name piclist \
--restart always \
-p 36677:36677 \
-v "./piclist:/root/.piclist" \
kuingsmile/piclist:latest \
node /usr/local/bin/picgo-server -k piclist123456
```

#### docker-compose

从piclist-core仓库下载`docker-compose.yml`文件,或者复制以下内容到`docker-compose.yml`文件中:

```yaml
version: '3.3'

services:
node:
image: 'kuingsmile/piclist:latest'
container_name: piclist
restart: always
ports:
- 36677:36677
volumes:
- './piclist:/root/.piclist'
command: node /usr/local/bin/picgo-server -k piclist123456
```
你可以修改`volumes`为你自己的路径,修改`command`为你自己的密钥。

然后运行

```bash
docker-compose up -d
```

## 已支持平台

| 平台 | 相册云删除 | 云存储管理 |
Expand Down

0 comments on commit 2de1a1f

Please sign in to comment.