| Build | Stable | Preview | Support Server |
|---|---|---|---|
 |
 |
 |
 |
- What is Suwayomi?
- Suwayomi client projects
- Downloading and Running the app
- Syncing With Tachiyomi
- Troubleshooting and Support
- Contributing and Technical info
- Credit
- License
A free and open source manga reader server that runs extensions built for Tachiyomi.
Suwayomi is an independent Tachiyomi compatible software and is not a Fork of Tachiyomi.
Suwayomi-Server is as multi-platform as you can get. Any platform that runs java and/or has a modern browser can run it. This includes Windows, Linux, macOS, chrome OS, etc. Follow Downloading and Running the app for installation instructions.
Ability to sync with Tachiyomi is a planned feature, for more info look here.
You need a client/user interface app as a front-end for Suwayomi-Server, if you Directly Download Suwayomi-Server you'll get a bundled version of Suwayomi-WebUI with it.
Here's a list of known clients/user interfaces for Suwayomi-Server:
- Suwayomi-WebUI: The web/ElectronJS front-end that Suwayomi-Server ships with by default.
- Tachidesk-JUI: The native desktop front-end for Suwayomi-Server. Currently, the most advanced.
- Tachidesk-Sorayomi: A Flutter front-end for Desktop(Linux, windows, etc.), Web and Android with a User Interface inspired by Tachiyomi.
- Tachidesk-VaadinUI: A Web front-end for Suwayomi-Server built with Vaadin.
- Suwayomi-VUI: A preview focused web frontend built with svelte with some features the other UIs might not have (migration)
- Tachidesk-qtui: A C++/Qt front-end for mobile devices(Android/linux), feature support is basic.
- Tachidesk-GTK: A native Rust/GTK desktop client.
- Equinox: A web user interface made with Vue.js.
Here is a list of current features:
- Installing and executing Tachiyomi's Extensions, So you'll get the same sources
- A library to save your mangas and categories to put them into
- Searching and browsing installed sources
- Ability to download Manga for offline read
- Backup and restore support powered by Tachiyomi-compatible Backups
- Viewing latest updated chapters.
Note: These are capabilities of Suwayomi-Server, the actual working support is provided by each front-end app, checkout their respective readme for more info.
To facilitate the use of Suwayomi we provide bundle releases that include The Java Runtime Environment, ElectronJS and the Suwayomi-Launcher.
If a bundle for your operating system or cpu architecture is not provided then refer to Advanced Methods
Download the latest win32(Windows 32-bit) or win64(Windows 64-bit) release from the releases section or a preview one from the preview repository.
Unzip the downloaded file and double-click on one of the launcher scripts.
Download the latest macOS-x64(older macOS systems) or macOS-arm64(Apple M1 and newer) release from the releases section or a preview one from the preview repository.
Unzip the downloaded file and double-click on one of the launcher scripts.
Download the latest linux-x64(x86_64) release from the releases section or a preview one from the preview repository.
tar xvf the downloaded file and double-click on one of the launcher scripts or run them using the terminal.
You can install Suwayomi from the AUR:
yay -S tachidesk
Download the latest deb package from the release section or Install from the MPR
git clone https://mpr.makedeb.org/suwayomi-server.git
cd suwayomi-server
makedeb -si
sudo add-apt-repository ppa:suwayomi/suwayomi-server
sudo apt update
sudo apt install suwayomi-server
Check our Official Docker release Suwayomi Container for running Suwayomi Server in a docker container. Source code for our container is available at docker-tachidesk. By default, the server will be running on http://localhost:4567 open this url in your browser.
Install from the command line:
$ docker pull ghcr.io/suwayomi/tachidesk
Run Container from the command line:
$ docker run -p 4567:4567 ghcr.io/suwayomi/tachidesk
In order to run the app you need the following:
- The jar release of Suwayomi-Server
- The Java Runtime Environment(JRE) 8 or newer
- A Browser like Google Chrome, Firefox, Edge, etc.
- ElectronJS (optional)
Download the latest .jar release from the releases section or a preview jar build from the preview repository.
Make sure you have The Java Runtime Environment installed on your system, Double-click on the jar file or run java -jar Suwayomi-Server-vX.Y.Z-rxxxx.jar from a Terminal/Command Prompt window to run the app which will open a new browser window automatically.
You can run Suwayomi on your computer or a server and connect to it remotely through one of our clients or the bundled web interface with a web browser. This method of using Suwayomi is requiring a bit of networking/firewall/port forwarding/server configuration/etc. knowledge on your side, if you can run a Minecraft server and configure it, then you are good to go.
Check out this wiki page for a guide on configuring Suwayomi-Server.
If you face issues with your setup then we are happy to provide help, just join our discord server(a discord badge is on the top of the page, you are just a click-clack away!).
- You can install the
Suwayomiextension inside tachiyomi. - The extension will load your Suwayomi library.
- By manipulating extension search filters you can browse your categories.
- You can enable the Suwayomi tracker to track reading progress with your Suwayomi server.
- Note: Tachiyomi only allows tracking one way, meaning that by reading chapters on other Suwayomi clients the last read chapter number will update on the tracker but tachiyomi won't automatically mark them as read for you.
Checkout this issue for tracking progress.
See this troubleshooting wiki page.
See CONTRIBUTING.md.
This project is a spiritual successor of TachiWeb-Server, Many of the ideas and the groundwork adopted in this project comes from TachiWeb.
The AndroidCompat module was originally developed by @null-dev for TachiWeb-Server and is licensed under Apache License Version 2.0 and Copyright 2019 Andy Bao and contributors.
Parts of tachiyomi is adopted into this codebase, also licensed under Apache License Version 2.0 and Copyright 2015 Javier Tomás.
You can obtain a copy of Apache License Version 2.0 from http://www.apache.org/licenses/LICENSE-2.0
Changes to both codebases is licensed under MPL v. 2.0 as the rest of this project.
Copyright (C) Contributors to the Suwayomi project
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
The developer of this application does not have any affiliation with the content providers available.
