# Tachidesk-docker | Status | Stable | Preview | Discord Support | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------:| | [![Build Docker Images](https://github.com/suwayomi/docker-tachidesk/actions/workflows/build_container_images.yml/badge.svg)](https://github.com/suwayomi/docker-tachidesk/actions/workflows/build_container_images.yml) [![Docker Pulls](https://img.shields.io/badge/dynamic/json?url=https://github.com/suwayomi/docker-tachidesk/raw/main/scripts/tachidesk_version.json&label=docker_pulls&query=$.total_downloads&color=blue)](https://github.com/orgs/suwayomi/packages/container/package/tachidesk) | [![Latest](https://img.shields.io/badge/dynamic/json?url=https://github.com/suwayomi/docker-tachidesk/raw/main/scripts/tachidesk_version.json&label=version&query=$.stable&color=blue)](https://github.com/orgs/suwayomi/packages/container/package/tachidesk/) | [![Preview](https://img.shields.io/badge/dynamic/json?url=https://github.com/suwayomi/docker-tachidesk/raw/main/scripts/tachidesk_version.json&label=version&query=$.preview&color=blue)](https://github.com/orgs/suwayomi/packages/container/package/tachidesk) | [![Discord](https://img.shields.io/discord/801021177333940224.svg?label=discord&labelColor=7289da&color=2c2f33&style=flat)](https://discord.gg/DDZdqZWaHA) | Run [Tachidesk-Server](https://github.com/Suwayomi/Tachidesk-Server) inside docker container as non-root user. The server will be running on http://localhost:4567 open this url in your browser. Docker Releases - https://github.com/suwayomi/docker-tachidesk/pkgs/container/tachidesk Dockerfile - https://github.com/suwayomi/docker-tachidesk _**Tachidesk data location - /home/suwayomi/.local/share/Tachidesk**_ Docker images are mutli-arch (linux/amd64, linux/arm/v7, linux/arm64, linux/ppc64le, linux/s390x) and has small size based on Ubuntu linux. Logs are sent to stdout and are not written to disk. ### Docker compose Use the template [docker-compose.yml](./docker-compose.yml) in this repo for creating and starting tachidesk docker container. # Environment Variables > [!NOTE] > See [server-reference.conf](https://github.com/Suwayomi/Suwayomi-Server/blob/master/server/src/main/resources/server-reference.conf) in the [Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server) repository for the default values > [!Tip] > Settings can be changed during runtime via the webUI. > [!CAUTION] > Providing an environment variable will overwrite the current value in the server.conf file. There are a number of environment variables available to configure Suwayomi: | Variable | Default | Description | |:--------------------------------:|:---------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | **TZ** | `Etc/UTC` | What time zone the container thinks it is. | | **BIND_IP** | `-` | The interface to listen on, inside the container. You almost never want to change this. | | **BIND_PORT** | `-` | Which port Suwayomi will listen on | | **SOCKS_PROXY_ENABLED** | `-` | Whether Suwayomi will connect through a SOCKS5 proxy | | **SOCKS_PROXY_HOST** | `-` | The TCP host of the SOCKS5 proxy | | **SOCKS_PROXY_PORT** | `-` | The port of the SOCKS5 proxy | | **DOWNLOAD_AS_CBZ** | `-` | Whether Suwayomi should save the manga to disk in CBZ format | | **BASIC_AUTH_ENABLED** | `-` | Whether Suwayomi requires HTTP Basic Auth to get in. | | **BASIC_AUTH_USERNAME** | `-` | The username to log in to Suwayomi. | | **BASIC_AUTH_PASSWORD** | `-` | The password to log in to Suwayomi. | | **DEBUG** | `-` | If extra logging is enabled. Useful for development and troubleshooting. | | **GQL_DEBUG** | `-` | If graphql logging is enabled. Useful for development and troubleshooting. Can overload the log output. | | **WEB_UI_ENABLED** | `-` | If the server should serve a webUI | | **WEB_UI_FLAVOR** | `-` | "WebUI" or "Custom" | | **WEB_UI_CHANNEL** | `-` | "bundled" (the version bundled with the server release), "stable" or "preview" - the webUI version that should be used | | **WEB_UI_UPDATE_INTERVAL** | `-` | Time in hours - 0 to disable auto update - range: 1 <= n < 24 - how often the server should check for webUI updates | | **AUTO_DOWNLOAD_CHAPTERS** | `-` | If new chapters that have been retrieved should get automatically downloaded | | **AUTO_DOWNLOAD_EXCLUDE_UNREAD** | `-` | Ignore automatic chapter downloads of entries with unread chapters | | **AUTO_DOWNLOAD_AHEAD_LIMIT** | `-` | 0 to disable - how many unread downloaded chapters should be available - if the limit is reached, new chapters won't be downloaded automatically | | **EXTENSION_REPOS** | `-` | Any additional extension repos to use, the format is `["https://github.com/MY_ACCOUNT/MY_REPO/tree/repo", "https://github.com/MY_ACCOUNT_2/MY_REPO_2/"]` | | **MAX_SOURCES_IN_PARALLEL** | `-` | Range: 1 <= n <= 20 - Sets how many sources can do requests (updates, downloads) in parallel. Updates/Downloads are grouped by source and all mangas of a source are updated/downloaded synchronously | | **UPDATE_EXCLUDE_UNREAD** | `-` | If unread manga should be excluded from updates | | **UPDATE_EXCLUDE_STARTED** | `-` | If manga that haven't been started should be excluded from updates | | **UPDATE_EXCLUDE_COMPLETED** | `-` | If completed manga should be excluded from updates | | **UPDATE_INTERVAL** | `-` | Time in hours - 0 to disable it - (doesn't have to be full hours e.g. 12.5) - range: 6 <= n < ∞ - Interval in which the global update will be automatically triggered | | **UPDATE_MANGA_INFO** | `-` | If manga info should be updated along with the chapters | | **BACKUP_TIME** | `-` | Range: hour: 0-23, minute: 0-59 - Time of day at which the automated backup should be triggered | | **BACKUP_INTERVAL** | `-` | # Time in days - 0 to disable it - range: 1 <= n < ∞ - Interval in which the server will automatically create a backup | | **BACKUP_TTL** | `-` | # Time in days - 0 to disable it - range: 1 <= n < ∞ - How long backup files will be kept before they will get deleted | # Docker tags ## Latest `ghcr.io/suwayomi/tachidesk:latest` The latest stable release of the server. Also tagged as `:stable`. ## Preview `ghcr.io/suwayomi/tachidesk:preview` The latest preview release of the server. Can be buggy! # Docker commands Expose to localhost ip docker run -p 127.0.0.1:4567:4567 ghcr.io/suwayomi/tachidesk:stable Expose to specific ip docker run -p 192.168.x.x:4567:4567 ghcr.io/suwayomi/tachidesk:stable Expose to all ips docker run -p 4567:4567 ghcr.io/suwayomi/tachidesk:stable Change the default UTC timezone. Use TZ database name from [Timezone list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) docker run -e "TZ=Europe/London" -p 127.0.0.1:4567:4567 ghcr.io/suwayomi/tachidesk:stable For Tachidesk Preview version docker run -p 127.0.0.1:4567:4567 ghcr.io/suwayomi/tachidesk:preview Persistent data of tachidesk on subsequent run docker run -p 127.0.0.1:4567:4567 -v :/./home/suwayomi/.local/share/Tachidesk ghcr.io/suwayomi/tachidesk For Specific Tachidesk stable version (from v0.3.9 onwards) docker run -p 127.0.0.1:4567:4567 ghcr.io/suwayomi/tachidesk:v0.3.9 # Credit [Tachidesk-Server](https://github.com/Suwayomi/Tachidesk-Server) is licensed under `MPL v. 2.0`. # License 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/.