{"id":15121147,"url":"https://github.com/suwayomi/suwayomi-server","last_synced_at":"2025-05-13T18:13:14.726Z","repository":{"id":37802011,"uuid":"323996203","full_name":"Suwayomi/Suwayomi-Server","owner":"Suwayomi","description":"A rewrite of Tachiyomi for the Desktop","archived":false,"fork":false,"pushed_at":"2025-05-06T15:43:20.000Z","size":48187,"stargazers_count":4948,"open_issues_count":116,"forks_count":232,"subscribers_count":54,"default_branch":"master","last_synced_at":"2025-05-06T16:53:10.669Z","etag":null,"topics":["desktop","hacktoberfest","javalin","kotlin","manga","manga-downloader","manga-reader","mangareader","self-hosted","tachidesk","tachidesk-server","tachiyomi"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Suwayomi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG-TEMPLATE.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-23T20:31:38.000Z","updated_at":"2025-05-06T13:35:20.000Z","dependencies_parsed_at":"2023-10-16T14:32:21.022Z","dependency_job_id":"9a3f1e21-4734-44ba-8ae9-3f414dc3aaa5","html_url":"https://github.com/Suwayomi/Suwayomi-Server","commit_stats":null,"previous_names":["suwayomi/suwayomi-server","suwayomi/tachidesk-server"],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suwayomi%2FSuwayomi-Server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suwayomi%2FSuwayomi-Server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suwayomi%2FSuwayomi-Server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suwayomi%2FSuwayomi-Server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Suwayomi","download_url":"https://codeload.github.com/Suwayomi/Suwayomi-Server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254000883,"owners_count":21997443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["desktop","hacktoberfest","javalin","kotlin","manga","manga-downloader","manga-reader","mangareader","self-hosted","tachidesk","tachidesk-server","tachiyomi"],"created_at":"2024-09-26T02:00:52.174Z","updated_at":"2025-05-13T18:13:14.697Z","avatar_url":"https://github.com/Suwayomi.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n| Build                                                                                         | Stable                                                                                                                                                                   | Preview                                                                                                                                                                                                                                           | Support Server |\n|-----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|\n| ![CI](https://github.com/Suwayomi/Suwayomi-Server/actions/workflows/build_push.yml/badge.svg) | [![stable release](https://img.shields.io/github/release/Suwayomi/Suwayomi-Server.svg?maxAge=3600\u0026label=download)](https://github.com/Suwayomi/Suwayomi-Server/releases) | [![preview](https://img.shields.io/badge/dynamic/json?url=https://github.com/Suwayomi/Suwayomi-Server-preview/raw/main/index.json\u0026label=download\u0026query=$.latest\u0026color=blue)](https://github.com/Suwayomi/Suwayomi-Server-preview/releases/latest) | [![Discord](https://img.shields.io/discord/801021177333940224.svg?label=discord\u0026labelColor=7289da\u0026color=2c2f33\u0026style=flat)](https://discord.gg/DDZdqZWaHA) |\n\n## Table of Content\n- [What is Suwayomi?](#what-is-suwayomi)\n- [Features](#Features)\n- [Suwayomi client projects](#Suwayomi-client-projects)\n- [Downloading and Running the app](#downloading-and-running-the-app)\n  * [Using Operating System Specific Bundles](#using-operating-system-specific-bundles)\n      - [Launcher Scripts](#launcher-scripts)\n    + [Windows](#windows)\n    + [macOS](#macos)\n    + [GNU/Linux](#gnulinux)\n  * [Other methods of getting Suwayomi](#other-methods-of-getting-suwayomi)\n    + [Arch Linux](#arch-linux)\n    + [Ubuntu-based distributions](#ubuntu-based-distributions)\n    + [Docker](#docker)\n  * [Advanced Methods](#advanced-methods)\n    + [Running the jar release directly](#running-the-jar-release-directly)\n    + [Using Suwayomi Remotely](#using-suwayomi-remotely)\n- [Syncing With Mihon (Tachiyomi)](#syncing-with-mihon-tachiyomi)\n- [Troubleshooting and Support](#troubleshooting-and-support)\n- [Contributing and Technical info](#contributing-and-technical-info)\n- [Credit](#credit)\n- [License](#license)\n\u003c!-- Generated with https://ecotrust-canada.github.io/markdown-toc/ --\u003e\n\n# What is Suwayomi?\n\u003cimg src=\"https://github.com/Suwayomi/Suwayomi-Server/raw/master/server/src/main/resources/icon/faviconlogo.png\" alt=\"drawing\" width=\"200\"/\u003e\n\nA free and open source manga reader server that runs extensions built for [Mihon (Tachiyomi)](https://mihon.app/). \n\nSuwayomi is an independent Mihon (Tachiyomi) compatible software and is **not a Fork of** Mihon (Tachiyomi).\n\nSuwayomi-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](#downloading-and-running-the-app) for installation instructions.\n\nYou can use Mihon (Tachiyomi) to access your Suwayomi-Server. For more info look [here](#syncing-with-mihon-tachiyomi).\n\n## Features\n\u003e [!NOTE]\n\u003e\n\u003e These are capabilities of Suwayomi-Server, the actual working support is provided by each front-end app, checkout their respective readme for more info.\n\n- Installing and executing Mihon (Tachiyomi)'s Extensions, So you'll get the same sources\n- Searching and browsing installed sources\n- A library to save your mangas and categories to put them into\n- Automated library updates to check for new chapters\n- Automated download of new chapters\n- Viewing latest updated chapters\n- Ability to download Manga for offline read\n- Backup and restore support powered by Mihon (Tachiyomi)-compatible Backups\n- Automated backup creations\n- Tracking via [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/), [MangaUpdates](https://www.mangaupdates.com/), etc.\n- [FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) support to bypass Cloudflare protection\n- Automated WebUI updates (supports the default WebUI and VUI)\n- OPDS and OPDS-PSE support (endpoint: `/api/opds/v1.2`)\n\n# Suwayomi client projects\n**You need a client/user interface app as a front-end for Suwayomi-Server, if you [Directly Download Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server/releases/latest) you'll get a bundled version of [Suwayomi-WebUI](https://github.com/Suwayomi/Suwayomi-WebUI) with it.**\n\nHere's a list of known clients/user interfaces for Suwayomi-Server (checkout the respective GitHub repository for their features):\n##### Actively Developed Clients\n- [Suwayomi-WebUI](https://github.com/Suwayomi/Suwayomi-WebUI): The web front-end that Suwayomi-Server ships with by default.\n- [Suwayomi-VUI](https://github.com/Suwayomi/Suwayomi-VUI): A Suwayomi-Server preview focused web frontend built with svelte\n- [Tachidesk-VaadinUI](https://github.com/Suwayomi/Tachidesk-VaadinUI): A Web front-end for Suwayomi-Server built with Vaadin.\n##### Inactive Clients (functional but outdated)\n- [Tachidesk-JUI](https://github.com/Suwayomi/Tachidesk-JUI): The native desktop front-end for Suwayomi-Server.\n- [Tachidesk-Sorayomi](https://github.com/Suwayomi/Tachidesk-Sorayomi): A Flutter front-end for Desktop(Linux, windows, etc.), Web and Android with a User Interface inspired by Mihon (Tachiyomi).\n#####  Abandoned Clients (functionality unknown)\n- [Tachidesk-qtui](https://github.com/Suwayomi/Tachidesk-qtui): A C++/Qt front-end for mobile devices(Android/linux), feature support is basic.\n- [Tachidesk-GTK](https://github.com/mahor1221/Tachidesk-GTK): A native Rust/GTK desktop client.\n- [Equinox](https://github.com/Suwayomi/Equinox): A web user interface made with Vue.js.\n\n# Downloading and Running the app\n## Using Operating System Specific Bundles\nTo facilitate the use of Suwayomi we provide bundle releases that include The Java Runtime Environment, ElectronJS and the Suwayomi-Launcher.\n\nIf a bundle for your operating system or cpu architecture is not provided then refer to [Advanced Methods](#advanced-methods)\n\n### Windows\nDownload the latest `win64`(Windows 64-bit) release from [the releases section](https://github.com/Suwayomi/Suwayomi-Server/releases) or a preview one from [the preview repository](https://github.com/Suwayomi/Suwayomi-Server-preview/releases).\n\nUnzip the downloaded file and double-click on one of the launcher scripts.\n\n### macOS\nDownload the latest `macOS-x64`(older macOS systems) or `macOS-arm64`(Apple M1 and newer) release from [the releases section](https://github.com/Suwayomi/Suwayomi-Server/releases) or a preview one from [the preview repository](https://github.com/Suwayomi/Suwayomi-Server-preview/releases).\n\nUnzip the downloaded file and double-click on one of the launcher scripts.\n\n### GNU/Linux\nDownload the latest `linux-x64`(x86_64) release from [the releases section](https://github.com/Suwayomi/Suwayomi-Server/releases) or a preview one from [the preview repository](https://github.com/Suwayomi/Suwayomi-Server-preview/releases).\n\n`tar xvf` the downloaded file and double-click on one of the launcher scripts or run them using the terminal.\n\n## Other methods of getting Suwayomi\n### Docker\nCheck our Official Docker release [Suwayomi Container](https://github.com/orgs/Suwayomi/packages/container/package/tachidesk) for running Suwayomi Server in a docker container. Source code for our container is available at [docker-tachidesk](https://github.com/Suwayomi/docker-tachidesk), an example compose file can also be found there. By default, the server will be running on http://localhost:4567 open this url in your browser.\n\n### Arch Linux\nYou can install Suwayomi from the AUR:\n```\nyay -S tachidesk\n```\n\n### Debian/Ubuntu\nDownload the latest deb package from the release section.\n\n\u003e [!CAUTION]\n\u003e These options are outdated and unmaintained ([relevant issue](https://github.com/Suwayomi/Suwayomi-Server/issues/1318))\n\u003e ### MPR\n\u003e ```\n\u003e git clone https://mpr.makedeb.org/tachidesk-server.git\n\u003e cd tachidesk-server\n\u003e makedeb -si\n\u003e ```\n\u003e ### Ubuntu\n\u003e ```\n\u003e sudo add-apt-repository ppa:suwayomi/tachidesk-server\n\u003e sudo apt update\n\u003e sudo apt install tachidesk-server\n\u003e ```\n\n### NixOS\nYou can deploy Suwayomi on NixOS using the module `services.suwayomi-server` in your configuration:\n\n```\n{\n  services.suwayomi-server = {\n    enable = true;\n  };\n}\n```\n\nFor more information, see [the NixOS manual](https://nixos.org/manual/nixos/stable/#module-services-suwayomi-server).\n\nYou can also directly use the package from [nixpkgs](https://search.nixos.org/packages?channel=unstable\u0026type=packages\u0026query=suwayomi-server).\n\n## Advanced Methods\n### Running the jar release directly\nIn order to run the app you need the following:\n- The jar release of Suwayomi-Server\n- The Java Runtime Environment(JRE) 21 or newer\n- A Browser like Google Chrome, Firefox, Edge, etc.\n- ElectronJS (optional)\n\nDownload the latest `.jar` release from [the releases section](https://github.com/Suwayomi/Suwayomi-Server/releases) or a preview jar build from [the preview repository](https://github.com/Suwayomi/Suwayomi-Server-preview/releases).\n\nMake 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.\n\n### Using Suwayomi Remotely\nYou 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.\n\nCheck out [this wiki page](https://github.com/Suwayomi/Suwayomi-Server/wiki/Configuring-Tachidesk-Server) for a guide on configuring Suwayomi-Server. \n\nIf 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!).\n\n## Syncing With Mihon (Tachiyomi)\n### The Suwayomi extension and tracker\n- You can install the `Suwayomi` extension inside Mihon (Tachiyomi).\n- The extension will load your Suwayomi library.\n- By manipulating extension search filters you can browse your categories.\n- You can enable the Suwayomi tracker to track reading progress with your Suwayomi server.\n  - Note: to sync from\n    - Mihon (Tachiyomi) to Suwayomi: Mihon (Tachiyomi) automatically updates the chapters read status when it's updating the tracker (e.g. while reading)\n    - Suwayomi to Mihon (Tachiyomi): To sync Mihon (Tachiyomi) with Suwayomi, you have to open the manga's track information, then, Mihon (Tachiyomi) will automatically update its chapter list with the state from Suwayomi\n\n### Other methods\nCheckout [this issue](https://github.com/Suwayomi/Suwayomi-Server/issues/159) for tracking progress.\n\n## Troubleshooting and Support\nSee [this troubleshooting wiki page](https://github.com/Suwayomi/Suwayomi-Server/wiki/Troubleshooting).\n\n## Contributing and Technical info\nSee [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## Credit\nThis project is a spiritual successor of [TachiWeb-Server](https://github.com/Tachiweb/TachiWeb-server), Many of the ideas and the groundwork adopted in this project comes from TachiWeb.\n\nThe `AndroidCompat` module was originally developed by [@null-dev](https://github.com/null-dev) for [TachiWeb-Server](https://github.com/Tachiweb/TachiWeb-server) and is licensed under `Apache License Version 2.0` and `Copyright 2019 Andy Bao and contributors`.\n\nParts of [Mihon (Tachiyomi)](https://github.com/mihonapp/mihon) is adopted into this codebase, also licensed under `Apache License Version 2.0` and `Copyright 2015 Javier Tomás`.\n\nYou can obtain a copy of `Apache License Version 2.0` from  http://www.apache.org/licenses/LICENSE-2.0\n\nChanges to both codebases is licensed under `MPL v. 2.0` as the rest of this project.\n\n## License\n\n    Copyright (C) Contributors to the Suwayomi project\n\n    This Source Code Form is subject to the terms of the Mozilla Public\n    License, v. 2.0. If a copy of the MPL was not distributed with this\n    file, You can obtain one at http://mozilla.org/MPL/2.0/.\n\n## Disclaimer\n\nThe developer of this application does not have any affiliation with the content providers available.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuwayomi%2Fsuwayomi-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuwayomi%2Fsuwayomi-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuwayomi%2Fsuwayomi-server/lists"}