From 2de1a1f0f67e5acdb9d1469388f81b9f46d3dcc2 Mon Sep 17 00:00:00 2001 From: Kuingsmile Date: Wed, 6 Dec 2023 20:31:41 -0800 Subject: [PATCH] :pencil: Docs(custom): add support for docker ISSUES CLOSED: #118 --- FAQ.md | 43 +++++++++++++++++++++++++++++++++++++++++++ FAQ_EN.md | 43 +++++++++++++++++++++++++++++++++++++++++++ README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README_cn.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 176 insertions(+) diff --git a/FAQ.md b/FAQ.md index 72ef999..ef758d9 100644 --- a/FAQ.md +++ b/FAQ.md @@ -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 +``` diff --git a/FAQ_EN.md b/FAQ_EN.md index baca537..0a06340 100644 --- a/FAQ_EN.md +++ b/FAQ_EN.md @@ -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 +``` \ No newline at end of file diff --git a/README.md b/README.md index d5322c6..0e3d4d0 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 | diff --git a/README_cn.md b/README_cn.md index 8ab9557..653dd5d 100644 --- a/README_cn.md +++ b/README_cn.md @@ -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中进行云端删除等功能。 @@ -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 +``` + ## 已支持平台 | 平台 | 相册云删除 | 云存储管理 |