From b2e74e482dc57f59f802a78dbb77f97221fb51b3 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 12 Nov 2025 21:23:45 +0000 Subject: [PATCH] action: wiki sync --- Configuring-Suwayomi‐Server.md | 23 ++++++++++++++++++++--- Getting-Extensions.md | 2 +- Local-Source.md | 4 ++-- Troubleshooting.md | 2 +- 4 files changed, 24 insertions(+), 7 deletions(-) diff --git a/Configuring-Suwayomi‐Server.md b/Configuring-Suwayomi‐Server.md index d567ed2..d5a1690 100644 --- a/Configuring-Suwayomi‐Server.md +++ b/Configuring-Suwayomi‐Server.md @@ -23,7 +23,7 @@ The configuration file is written in HOCON. Google is your friend if you want to server.ip = "0.0.0.0" server.port = 4567 ``` -- `server.ip` can be a IP or domain name. +- `server.ip` can be an IP or domain name. ### Socks5 proxy ``` @@ -78,8 +78,8 @@ server.downloadConversions = {} - `server.excludeEntryWithUnreadChapters = true` controls if Suwayomi will download new chapters for titles with unread chapters (requires `server.autoDownloadNewChapters`). - `server.autoDownloadNewChaptersLimit = 0` sets how many chapters should be downloaded at most, `0` to disable the limit; if the limit is reached, new chapters will not be downloaded (requires `server.autoDownloadNewChapters`). - `server.autoDownloadIgnoreReUploads = false` controls if Suwayomi will re-download re-uploads on update (requires `server.autoDownloadNewChapters`). -- `server.downloadConversions = {}` configures optional image conversions for all downloads. This is an [JSON object](https://en.wikipedia.org/wiki/JSON#Syntax), with the source image [mime type](https://en.wikipedia.org/wiki/Media_type) as the key and an object with the target mime type and options as value. - The following options are both valid: +- `server.downloadConversions = {}` configures optional image conversions for all downloads. This is an [JSON object](https://en.wikipedia.org/wiki/JSON#Syntax), with the source image [mime type](https://en.wikipedia.org/wiki/Media_type) as the key and an object with the target mime type or url and options as value. + The following options are all valid: ``` server.downloadConversions = { "image/webp" : { target : "image/jpeg", compressionLevel = 0.8 }} # -- or -- @@ -87,8 +87,25 @@ server.downloadConversions = {} target = "image/jpeg" # image type to convert to compressionLevel = 0.8 # quality in range [0,1], leave away to use default compression } + # -- a url example -- + server.downloadConversions = { "default" : { target : "http://localhost:9999/convert" }} + # -- a url with all parameters example -- + server.downloadConversions = { + "default" : { + target : "http://localhost:9999/convert", + callTimeout : 10m, + connectTimeout : 10s, + headers : { + "authorization" : "MyPassword" + } + } + } ``` A source mime type `default` can be used as fallback to convert all images; a target mime type of `none` can be used to disable conversion for a particular format. + + This is an example curl command for what Suwayomi-Server will send to the conversion url: `curl -X POST "http://localhost:9999/convert" -F "image=@cat.png;type=image/png"` +- `server.serveConversions = {}` configures optional image conversions before serving the image to the client. It follows the same format as `server.downloadConversions`. + ### Updater ``` diff --git a/Getting-Extensions.md b/Getting-Extensions.md index 74ab2e1..2631cb8 100644 --- a/Getting-Extensions.md +++ b/Getting-Extensions.md @@ -1,5 +1,5 @@ 1. **Install the latest version(or preview):** https://github.com/Suwayomi/Suwayomi-Server/releases/latest -2. Find an extensions repo, there is now no default extensions and you have to use google to find a Tachiyomi extension repo. +2. Find an extensions repo, there is now no default extensions, and you have to use Google to find a Tachiyomi extension repo. - Note: The repo should look like `https://raw.githubusercontent.com/user/reponame` or `https://www.github.com/user/reponame` 3. Configure it using one of the following: - Suwayomi-Server option 1: With the **new launcher**, go to the `Extensions` tab and add the extensions repo. diff --git a/Local-Source.md b/Local-Source.md index f3969a2..3dedf51 100644 --- a/Local-Source.md +++ b/Local-Source.md @@ -5,7 +5,7 @@ Follow the steps below to create local manga. If you add more chapters then you'll have to manually refresh the chapter list. -Supported chapter formats are folder with pictures inside (such as `.jpg`, `.png`, etc), `ZIP`/`CBZ`, `RAR`/`CBR` and `EPUB`. But expect better performance with directories and `ZIP`/`CBZ`. +Supported chapter formats are folder with pictures inside (such as `.jpg`, `.png`, etc.), `ZIP`/`CBZ`, `RAR`/`CBR` and `EPUB`. But expect better performance with directories and `ZIP`/`CBZ`. **Note:** While Suwayomi does support chapters compressed as **RAR** or **CBR**, note that **RAR** or **CBR** files using the **RAR5** format are not supported yet. @@ -111,7 +111,7 @@ Archive files such as `ZIP`/`CBZ` are supported but the folder structure inside It is possible to add details to local manga. Like manga from other catalogs, you add information about the manga such as the author, artist, description, and genre tags. -To import details along with your local manga, you have to create a json file. It can be named anything but it must be placed within the **Manga** folder. A standard file name is `details.json`. This file will contain the extended details about the manga in the `JSON` format. You can see the example below on how to build the file. Once the file is there, the app should load the data when you first open the manga or you can pull down to refresh the details. +To import details along with your local manga, you have to create a json file. It can be named anything but it must be placed within the **Manga** folder. A standard file name is `details.json`. This file will contain the extended details about the manga in the `JSON` format. You can see the example below on how to build the file. Once the file is there, the app should load the data when you first open the manga, or you can pull down to refresh the details. You can copy the following example and edit the details as needed: ``` json diff --git a/Troubleshooting.md b/Troubleshooting.md index de4a5fe..0e7a673 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -1,5 +1,5 @@ ## General Troubleshooting -This guide will try to fix Suwayomi by reseting it to a clean install state. +This guide will try to fix Suwayomi by reseting it to a clean installation state. - Make sure you have a recent backup of your library or create one in the app (if possible) because we **are going to wipe all Suwayomi data**. - Make sure Suwayomi is not running (right click on tray icon and quit or kill it through the way your Operating System provides)