Tachidesk is a desktop/server port of Tachiyomi, THE LEGENDARY free and open-source manga reader for mobile devices. This repo hosts some ready made scripts that make deploying Tachidesk easier on Dockerfile supported PaaS like Heroku, Railway, Render etc.
- Fork, or use this repo directly if the PaaS supports it, doesn't actually matter.
- There are two ways you can use this repo. With automated cloud backup support, or without. I recommend the former since most platforms this repo was designed for offer temporary/ephemeral storage and you most probably don't want to lose your data. (Yes, I know that Tachidesk supports backing up library entries but what i wanted was a more automated and hassle free solution, this repo tries to accomplish exactly that)
- If you decided how you want to deploy, just head to the next section and prepare the necessary variables needed for automated cloud backups.
Required for normal setup.
| Variable Name | Details | Required | Default | Example |
|---|---|---|---|---|
PORT |
The web port of Tachidesk Server. Platforms like Heroku, Render or Railway offer a PORT variable for your application by default. If leaving it to grab the default port causes some issue, try to set it manually. | Yes | Platform provided | 80 |
BRANCH |
The branch of Tachidesk you want to deploy. There are two options, stable or preview. The latter is unstable as it is built on every new push on the main repo. |
Yes | stable |
stable or preview |
AUTH_USER |
Username for basic authentication. You need to set this manually. | Yes | N/A | user |
AUTH_PASS |
Password for basic authentication. You need to set this manually. | Yes | N/A | pass |
Required for automated backups using Rclone.
| Name | Details | Required | Default | Example |
|---|---|---|---|---|
BACKUP_FREQUENCY |
This decides how frequent you want to run the backup task. Value should be in seconds. Depending on the size of your library and how frequent you add/delete/download entries, you should not set this value to smaller than 900. |
Yes | 3600 |
900 |
RCLONE_CONF |
Direct URL to a rclone.conf file which contains a remote named backup. You can generate the config file using a local Rclone installation on your device. Guiding how to setup rclone locally is beyond the scope of this project so you have to manage that yourself. If you're on mobile device, you can use an app called RCX abailable on Play Store or GitHub. |
Yes | N/A | https://gist.github.com/abcd1234/raw/rclone.conf |
RCLONE_CONFIG_PASS |
If the rclone.conf file you've provided in the RCLONE_CONF variable is encrypted locally, set the decryption key as the value to this variable. |
Yes (If your configuration file is encrypted) | N/A | N/A |
✍️ Notes:
- If you don't want automated cloud backups then don't set the
RCLONE_CONFvariable at all.
- Fork the repo and connect Replit with your GitHub account.
- Set necessary environment variables using the secrets tab.
- Now all you need to do is run the repl and you're good to go.
Note:
- Repl servers block most NSFW sites so you need a working SOCKS5 proxy to unblock those extensions. You can try searching online for free SOCKS5 proxies but most of them will probably be dead so you can either create a proxy server yourself or buy them. Now, if you finally get your hands on one, you can just edit the
server.conflocated insidetachideskfolder and add the proxy details.
- Fork the repo and connect Railway with your GitHub account.
- Create a new project and a service using the forked repo.
- Set necessary environment variables.
- Trigger a new deployment if the previous deployment failed (Add a random environment variable)
- Make a new Render account.
- Copy the URL of this repo, create a new web service from it.
- Set necessary environment variables.
- Deploy, that's it.
- Restart/redeploy the service everytime you want to update the server to the latest available version.