Re-write backups page (#42)

* re-write backups page

removed bunch of old info
edited to current details
added new stuff like auto sync

* fix broken links

tfw /

* SY

* move around the backup tip and reword a bit

* fix link fragments

* Add PR suggestions

rewording, consistency, and editing
This commit is contained in:
nicki 2023-09-10 14:08:10 -05:00 committed by GitHub
parent 1f1c3b4184
commit a031b852cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,19 +5,7 @@ description: Backups helps you prevent losing your library if something happens.
# Backups
Backups in **Tachiyomi** are compatible between different versions of the app, with a few exceptions listed under forks information.
## What's included in a backup?
Backups store the following information:
- **Titles**
- **Categories**
- **Read chapters**
- **Tracking settings**
- **Reading history**
- **Series information**
- Author, Artist, Date Added to Library, Selected Viewer, Read Duration, etc.
Backups in **Tachiyomi** are compatible between different versions of the app.
::: tip How to create a backup
1. Go to <nav to="backup-and-restore">.
@ -28,19 +16,48 @@ Backups store the following information:
![Backup and Restore](/docs/guides/backups/backup.dark.webp#dark =414x215)
:::
## General backup details
### What's included in a backup?
Backups store the following information:
- **Titles**
- **Categories**
- **Read chapters** for titles in Library
- **Tracking settings**
- **Reading history**
- **Series information**
- Author, Artist, Date Added to Library, Selected Viewer, Read Duration, etc.
- **Extensions** used
### What's NOT included in a backup?
Backups do NOT store:
- **Reading history** of titles NOT in library
- **Settings** including app settings and extension-specific settings
- **Downloaded** chapters including [local source](/docs/guides/local-source/) chapters
## Restoring a backup
Restoring a backup can be done through the Backup and Restore settings.
To ensure a smooth restoration process, remember to:
1. Log into the Tracking services you previously used.
1. Download any extensions you've used in your backup.
## Transferring downloads to a new installation
Before starting to import the selected backup, the app will remind the user of these.
You can transfer downloaded series chapters from one version of **Tachiyomi** to another.
### Transferring downloads to a new installation
## Enabling automatic backups
You can transfer downloaded series chapters from one version of **Tachiyomi** to another
by correctly specifying the Download Location.
## Suggestions for backups
### Enabling automatic backups
It is highly recommended to enable automatic backups to ensure you can recover in case of any issues.
@ -51,19 +68,44 @@ This way, you can recover from catastrophic failures.
![Automatic Backups](/docs/guides/backups/automatic_backups.light.webp#light =414x402)
![Automatic Backupse](/docs/guides/backups/automatic_backups.dark.webp#dark =414x402)
![Automatic Backups](/docs/guides/backups/automatic_backups.dark.webp#dark =414x402)
:::
## Forks information
### Syncing backups with external cloud services
Some forks of **Tachiyomi** have specific limitations regarding backup restoration:
Cross device sync in **Tachiyomi** is not planned in the future, but users can use
[Autosync for Google Drive](https://play.google.com/store/apps/details?id=com.ttxapps.drivesync)
in order to sync backup files to Drive automatically with the following steps:
1. Install the app from the link above
2. Enable [Automatic Backups](/docs/guides/backups#enabling-automatic-backups) and set it to your desired frequency and storage location.
3. Download the latest backup from Google Drive and restore to whatever device you have
Users who are familiar with [FolderSync](https://play.google.com/store/apps/details?id=dk.tacit.android.foldersync.lite)
or [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm) can setup auto sync of their backups similarly
## Additional information for forks
::: warning
This section explores some extra details regarding [forks](/forks/).
:::
All [Endorsed Tachiyomi forks](/forks/) support the `.proto.gz` format to backup/restore your library
In addition, some forks have specific limitations regarding backup restoration:
- [Neko](/forks/Neko/) can only restore [MangaDex](/extensions/#all.mangadex) entries in a backup.
> Entries from other sources will not transfer.
- Some forks, such as [TachiyomiAZ](/forks/TachiyomiAZ/) and [TachiyomiSY](/forks/TachiyomiSY/), have built-in extensions.
> Example: [E-Hentai](/extensions/#all.ehentai), [nHentai](/extensions/#all.nhentai), and **Hitomi.la**.
- Restoring a backup made by these forks to standard **Tachiyomi** will not restore titles from such extensions.
> While it is possible to restore titles to these forks, backing them up out of these forks is not possible.
- Some forks only support restoring legacy backups and haven't implemented the changes needed for new backup formats yet.
> Migrate everything to MangaDex if you require to.
- All forks have fork-specific settings and changes that might be saved in Backups.
Such settings are not restored in original Tachiyomi and will get lost when creating a new backup.
> For Example: [TachiyomiSY](/forks/TachiyomiSY/) has the option to backup/restore saved searches.
These will **NOT** be restored to original Tachiyomi or its forks.
- Only [TachiyomiAZ](/forks/TachiyomiAZ/) supports creating/restoring legacy `.json` backups and current `.proto.gz` backups.
> Users are recommended to update their `.json` backups to use the improved and efficient `.proto.gz` backups.
Be aware of these limitations when dealing with backups in different **Tachiyomi** forks.