Skip to content

Commit

Permalink
📝 Docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kuingsmile committed May 9, 2023
1 parent ae02a56 commit 80057c8
Show file tree
Hide file tree
Showing 4 changed files with 139 additions and 28 deletions.
9 changes: 7 additions & 2 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ PicList计划整合和优化现有插件,内置更多的常用图床。

## 6. Github 图床有时能上传,有时上传失败

1. GitHub 图床不支持上传同名文件,如果有同名文件上传,会报错。建议开启 `时间戳重命名` 避免同名文件。
2. GitHub 服务器和国内 GFW 的问题会导致有时上传成功,有时上传失败,无解。想要稳定请使用付费云存储,如阿里云、腾讯云等,价格也不会贵。
GitHub 服务器和国内 GFW 的问题会导致有时上传成功,有时上传失败,无解。

想要稳定请使用付费云存储,如阿里云、腾讯云等,价格也不会贵。

## 7. Mac 上无法打开 PicList 的主窗口界面

Expand Down Expand Up @@ -92,3 +93,7 @@ Linux: `$XDG_CONFIG_HOME/piclist/assets/simhei.ttf` or `~/.config//assets/simhei
macOS: `~/Library/Application\ Support/picgo/assets/simhei.ttf`

字体文件下载地址:[https://release.piclist.cn/simhei.ttf](https://release.piclist.cn/simhei.ttf)

## 13. 使用aws-s3插件上传到cloudflare R2时出现上传失败问题

R2的endpoint地址会出现被GFW sni阻断的问题,查看piclist.log后将对应的ip地址加入代理列表可解决。
106 changes: 106 additions & 0 deletions FAQ_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# FAQ

This FAQ has been modified from PicGo's FAQ, and thanks to the author Molunerfinn for PicGo.

## Common Questions

> The upload tool of this software is mainly derived from PicGo, with minimal changes. Please refer to PicGo's [user manual](https://picgo.github.io/PicGo-Doc/zh/guide/getting-started.html#%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B) for more information.
## 1. What is the relationship between PicList and PicGo?

PicList is forked from the PicGo project and is based on PicGo for secondary development. At the same time, the core function kernel PicGo-Core has been developed for the second time and renamed as [PicList-Core](https://github.com/Kuingsmile/PicList-Core).

The addition of all new features to PicList has not affected PicGo's existing functions, so you can use all PicGo plugins in PicList. At the same time, it can still be used in conjunction with software such as Typora and Obsidian.

## 2. When using the image hosting management function, errors such as "unable to retrieve directory" occur

Please check the log file `manage.log`. In addition, the API calls of various platforms have a limit on the number of calls per hour. If an error occurs, please try again later.

## 3. Which remote image hosting deletion is supported?

Currently, the supported image hosting platforms are:

- Aliyun OSS
- Tencent Cloud COS
- Qiniu Cloud Kodo
- Upyun
- SM.MS
- Imgur
- GitHub
- Webdav
- Aws S3

## 4. Is it possible to upload video files?

Yes. With the newly added image hosting management function, you can upload files of any format, including video files. At the same time, when uploading in the management interface, using methods such as chunked uploading and streaming uploading is faster and more stable compared to the base64 conversion method built into PicGo.

## 5. Does PicList support a certain image hosting platform?

PicList itself supports the following image hosting platforms:

- Qiniu Cloud
- Tencent Cloud COS
- Upyun
- GitHub
- SM.MS
- Aliyun OSS
- Imgur
- Webdav

PicList plans to integrate and optimize existing plugins and embed more commonly used image hosting platforms.

In addition, PicList is compatible with PicGo's plugin system. If you need support for other image hosting platforms, you can refer to the [PicGo third-party plugins](https://github.com/PicGo/Awesome-PicGo). If you still cannot find the image hosting platform you need, please develop a plugin for everyone to use.

## 6. The GitHub image hosting platform sometimes uploads successfully and sometimes fails

The problem with GitHub servers and China's Great Firewall may cause successful or failed uploads. There is no solution.

If you want stability, please use paid cloud storage such as Aliyun and Tencent Cloud. The price is not expensive.

## 7. The main window interface of PicList cannot be opened on Mac

To open the main window, right-click or two-finger tap the PicList icon in the top bar and select "Open Main Window."

Or right-click the PicList icon in the dock and select "Open Main Window."

## 8. 上传失败,或者是服务器出错

1. PicList 自带的图床都经过测试,上传出错一般都不是 PicList 自身的原因。如果你用的是 GitHub 图床请参考上面的第 7 点。
2. 检查 PicList 的日志(报错日志可以在 PicList 设置 -> 设置日志文件 -> 点击打开 后找到),看看 `[PicList Error]` 的报错信息里有什么关键信息
1. 先自行搜索 error 里的报错信息,往往你能百度或者谷歌出问题原因,不必开 issue。
2. 如果有带有 `401``403``40X` 状态码字样的,不用怀疑,就是你配置写错了,仔细检查配置,看看是否多了空格之类的。
3. 如果带有 `HttpError``RequestError``socket hang up` 等字样的说明这是网络问题,我无法帮你解决网络问题,请检查你自己的网络,是否有代理,DNS 设置是否正常等。
3. 通常网络问题引起的上传失败都是因为代理设置不当导致的。如果开启了系统代理,建议同时也在 PicList 的代理设置中设置对应的HTTP代理。

1. PicList's built-in image hosting platforms have been tested, and upload errors are generally not caused by PicList itself. If you are using the GitHub image hosting platform, please refer to the 7th point above.
2. Check PicList's log (the error log can be found by clicking "Open" in PicList Settings -> Set Log File ->), and see if there is any key information in the `[PicList Error]` error message
1. First search for the error message in the error message by yourself, and you can often Baidu or Google the cause of the problem, so you don't need to open an issue.
2. If there are `401`, `403` and other `40X` status code words, don't doubt it, it means that your configuration is wrong, check the configuration carefully to see if there are extra spaces, etc.
3. If there are words such as `HttpError`, `RequestError`, `socket hang up`, etc., it means that this is a network problem, and I cannot help you solve the network problem. Please check your own network, whether there is a proxy, whether the DNS setting is normal, etc.
3. Usually, upload failures caused by network problems are caused by improper proxy settings. If the system proxy is turned on, it is recommended to set the corresponding HTTP proxy in the proxy settings of PicList at the same time.

## 10. After installing the macOS version, there is no main interface

Please find the icon of PicList in the top bar, and then right-click (touchpad two-finger tap, or right-click the mouse) to find the menu of "Open Main Window".

Or right-click on the icon of PicList in the Docker bar to find the menu of "Open Main Window".

## 11. After installing PicList on macOS, it shows "The file is damaged" or there is no response after installing and opening

Please upgrade PicList to version 1.4.1 or above. Starting from 1.4.1, PicList has been signed by Apple and will not have this problem again.

## 12. Watermark is not added normally

Before adding a watermark, PicList will check whether the font file exists. If it does not exist, it will automatically download the font file. However, due to network problems, the font file may fail to download, and the watermark will be skipped.

Please check whether the font file under the corresponding path according to your system exists. If it does not exist, please download the font file manually and put it in the corresponding path.

Windows: `%APPDATA%\piclist\assets\simhei.ttf`
Linux: `$XDG_CONFIG_HOME/piclist/assets/simhei.ttf` or `~/.config//assets/simhei.ttf`
MacOS: `~/Library/Application\ Support/picgo/assets/simhei.ttf`

The font file download address: [https://release.piclist.cn/simhei.ttf](https://release.piclist.cn/simhei.ttf)

## 13. Upload failed when using aws-s3 plugin to upload to cloudflare R2

R2's endpoint address will be blocked by GFW sni. After checking piclist.log, adding the corresponding IP address to the proxy list can solve the problem.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,19 @@ MacOS:

| 平台 | 相册云删除 | 云存储管理 |
| :------------: | :--------: | :--------: |
| SM.MS | ✔️ | ✔️ |
| Github | ✔️ | ✔️ |
| Imgur | ✔️ | ✔️ |
| 腾讯COS V5 | ✔️ | ✔️ |
| 阿里云OSS | ✔️ | ✔️ |
| 又拍云 | ✔️ | ✔️ |
| 七牛云 | ✔️ | ✔️ |
| S3 API兼容平台 | ✔️ | ✔️ |
| WebDAV | ✔️ | ✔️ |

| 插件 | 相册云删除 |
| :-------------------------------------------------------: | :--------: |
| [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) | ✔️ |
| SM.MS | ✔️ | ✔️ |
| Github | ✔️ | ✔️ |
| Imgur | ✔️ | ✔️ |
| 腾讯COS V5 | ✔️ | ✔️ |
| 阿里云OSS | ✔️ | ✔️ |
| 又拍云 | ✔️ | ✔️ |
| 七牛云 | ✔️ | ✔️ |
| S3 API兼容平台 | ✔️ | ✔️ |
| WebDAV | ✔️ | ✔️ |

| 插件 | 相册云删除 |
| :----------------------------------------------------------: | :--------: |
| [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) | ✔️ |

## 下载安装

Expand Down
26 changes: 13 additions & 13 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,19 +84,19 @@ Search and install `Image auto upload Plugin` in the community plugin, then ente

| Platform | Album cloud deletion | Cloud storage management |
| :------------------------: | :------------------: | :----------------------: |
| SM.MS | ✔️ | ✔️ |
| Github | ✔️ | ✔️ |
| Imgur | ✔️ | ✔️ |
| Tencent COS V5 | ✔️ | ✔️ |
| Aliyun OSS | ✔️ | ✔️ |
| Upyun | ✔️ | ✔️ |
| Qiniu | ✔️ | ✔️ |
| S3 API compatible platform | ✔️ | ✔️ |
| WebDAV | ✔️ | ✔️ |

| Plugin | Album cloud deletion |
| :-------------------------------------------------------: | :------------------: |
| [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) | ✔️ |
| SM.MS | ✔️ | ✔️ |
| Github | ✔️ | ✔️ |
| Imgur | ✔️ | ✔️ |
| Tencent COS V5 | ✔️ | ✔️ |
| Aliyun OSS | ✔️ | ✔️ |
| Upyun | ✔️ | ✔️ |
| Qiniu | ✔️ | ✔️ |
| S3 API compatible platform | ✔️ | ✔️ |
| WebDAV | ✔️ | ✔️ |

| Plugin | Album cloud deletion |
| :----------------------------------------------------------: | :------------------: |
| [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) | ✔️ |

## Download and install

Expand Down

0 comments on commit 80057c8

Please sign in to comment.