Build	Stable	Preview	Support Server

Table of Content

• What is Tachidesk?
• Tachidesk client projects
  • Is this application usable? Should I test it?
• Downloading and Running the app
  • Using Operating System Specific Bundles
    • Launcher Scripts
    • Windows
    • macOS
    • GNU/Linux
  • Other methods of getting Tachidesk
    • Arch Linux
    • Ubuntu-based distributions
    • Docker
  • Advanced Methods
    • Running the jar release directly
    • Using Tachidesk Remotely
• Syncing With Tachiyomi
• Troubleshooting and Support
• Contributing and Technical info
• Credit
• License

What is Tachidesk?

A free and open source manga reader server that runs extensions built for Tachiyomi.

Tachidesk is an independent Tachiyomi compatible software and is not a Fork of Tachiyomi.

Tachidesk is a general term used to describe the combination of Tachidesk-Server(this project) and one of our clients. Think of it roughly like the concept of "distribution" in GNU/Linux distributions, in which Linux(Tachidesk-Server) is the kernel and the difference is which desktop environment(Tachidesk client) you get with it.

Tachidesk-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.

Tachidesk client projects

You need a client/user interface app as a front-end for Tachidesk-Server, if you Directly Download Tachidesk-Server you'll get a bundled version of Tachidesk-WebUI with it.

Here's a list of known clients/user interfaces for Tachidesk-Server:

Actively Developed Cients

• Tachidesk-WebUI: The web/ElectronJS front-end that Tachidesk-Server is traditionally shipped with. Usually gets new features faster.
• Tachidesk-JUI: The native desktop front-end for Tachidesk-Server. Currently the most advanced.
• Tachidesk-qtui: A C++/Qt front-end for mobile devices(Android/linux), in super early stage of development.
• Tachidesk-Sorayomi: A Flutter front-end for Desktop(Linux, windows, etc.), Web and Android. UI and UX similar to Tachiyomi.

Inctive/Abandoned Cients

• Equinox: A web user interface made with Vue.js, in super early stage of development.
• Tachidesk-GTK: A native Rust/GTK desktop client, in super early stage of development.

Is this application usable? Should I test it?

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 Tachidesk-Server, the actual working support is provided by each front-end app, checkout their respective readme for more info.

Downloading and Running the app

Using Operating System Specific Bundles

To facilitate the use of Tachidesk we provide bundle releases that include The Java Runtime Environment, ElectronJS and 3 Tachidesk Launcher Scripts.

If a bundle for your operating system or cpu architecture is not provided then refer to Advanced Methods

Launcher Scripts

• Tachidesk Electron Launcher: Launches Tachidesk inside Electron as a desktop applicaton
• Tachidesk Browser Launcher: Launches Tachidesk in a browser window
• Tachidesk Debug Launcher: Launches Tachidesk with debug logs attached. If Tachidesk doesn't work for you, running this can give you insight into why.

Node: Linux launcher scripts are named a bit differently but work the same.

Windows

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.

macOS

Download the latest macOS-x64(older macOS systems) or macOS-arm64(Apple M1) 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.

GNU/Linux

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.

Other methods of getting Tachidesk

Arch Linux

You can install Tachidesk from the AUR:

yay -S tachidesk

Debian/Ubuntu

Download the latest deb package from the release section or Install from the MPR

git clone https://mpr.makedeb.org/tachidesk-server.git
cd tachidesk-server
makedeb -si

Ubuntu

sudo add-apt-repository ppa:suwayomi/tachidesk-server
sudo apt update
sudo apt install tachidesk-server

Docker

Check our Official Docker release Tachidesk Container for running Tachidesk 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

Advanced Methods

Running the jar release directly

In order to run the app you need the following:

• The jar release of Tachidesk-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 Tachidesk-vX.Y.Z-rxxxx.jar from a Terminal/Command Prompt window to run the app which will open a new browser window automatically.

Using Tachidesk Remotely

You can run Tachidesk 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 Tachidesk is requires 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 Tachidesk-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!).

Syncing With Tachiyomi

The Tachidesk extension

• You can install the Tachidesk extension inside tachiyomi.
• The extension will load Tachidesk library.
• By manipulating filters you can browse your categories.

Other methods

Checkout this issue for tracking progress.

Troubleshooting and Support

See this troubleshooting wiki page.

Contributing and Technical info

See CONTRIBUTING.md.

Credit

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.

License

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/.