Download

Sync

Sync

Sync keeps your library, reading progress, history and settings the same on your phone, tablet and computer, through a server you run yourself. Every device keeps its own full copy and works offline.

What syncs #

Synced Stays on each device
Library, categories, read state and reading progress Downloads
History and statistics Logins to sites
Profiles and merged entries Screen and storage settings
Your settings, custom covers and fonts, extension repositories The device's own sync options

Each device chooses what it syncs under Settings › Sync › What syncs: reading history, statistics, categories, covers, fonts and other data, the settings of each Settings area, and which profiles. Library and reading progress always syncs. While the device syncs, Settings marks which settings sync, and the app bar of each Settings screen opens its area's list. The Library area also has a switch each for Library sort, Library filters and Chapter list defaults, which you set from menus rather than Settings.

Each profile syncs as itself, so a family's profiles stay apart on every device. In a profile's menu under Settings › Profiles, Sync this profile turns it on or off for this device. A profile made on another device comes here on its own, unless Ask before a new profile comes here is on. Titles whose extension isn't installed on a device are listed under Install extensions for your titles on its Sync page.

Sync needs a server. One person runs it, and everyone with an account on it can sync; Running a sync server explains how.

Sign in the first device #

  1. Open Settings › Sync and select Sign in with server address.
  2. Enter the server's address, such as https://sync.example.com.
  3. Sign in with the username and password the server's admin gave you, or select I have an invite code, enter the code and choose your own.

The first sync uploads this device's library, or downloads the account's. Covers, fonts and the first download wait for Wi-Fi unless Use mobile data for covers, fonts and first download is on. Changes sync on any network unless Use mobile data for changes is off.

When this device and the account both have data, Before the first sync shows how they come together: libraries, read state, history and progress are merged and nothing is deleted. Each of this device's profiles either pairs with one of the account's or is added as new; where only the name matches, choose Same as that profile or Add as new. For each paired profile, choose whether the account's settings or this device's settings are kept. Settings tied to the device, such as screen, storage and network ones, are never replaced.

LinuxKatari keeps the sign-in in the desktop's keyring. Without one running, such as GNOME Keyring or KWallet, the Sync page asks you to start one.

The Sync page
  1. On a device that already syncs, open Settings › Sync › Link a device. It shows a code that works for two minutes.
  2. On the new device, open Settings › Sync and select Scan a code from a linked device. Without a camera, select Enter a code from a linked device and type the server address and code instead.
  3. Confirm Join.

Signing in with your username and password on the new device works too.

Link a device

Offline, and picking up on another device #

Everything works without a connection. What you change is saved on the device and syncs when it can reach the server again; until then the Sync page says Offline · changes will sync when you're online. While Katari is closed, it syncs with Sync in the background on, every 30 minutes unless How often says otherwise. Pause syncing keeps changes on the device until you turn it off.

When another device got further in a title, opening it in the reader or player offers to go there, such as Desktop is further over Chapter 12, page 18. Select Go there to jump, or dismiss it to stay.

History names the device a title was last read on when it wasn't this one.

Pick up where you stopped

Needs your answer #

Most changes on two devices merge on their own. A few can't, so Katari keeps both and asks: the entry shows a banner, a notification says Open Sync to choose, and the Sync page offers Review and answer.

  • Migrated on two devices: a title was migrated to different sources on two devices. Both editions stay in your library until you choose one.
  • Notes edited on two devices: the later notes show for now. Choose Keep these for one version, or Keep both.
  • A deleted profile: a profile was deleted on one device while another device still changed things in it. It's kept until you choose Keep profile or delete it.

Restore a backup while syncing #

Restoring a backup on a device that syncs asks How far the restore reaches (see Backups and storage):

  • Restore on this device fills in what's missing or older. Changes made on your other devices after the backup was made are kept.
  • Roll back the whole account returns every device to the backup. Libraries, progress, history and settings changed anywhere after it are lost; profiles the backup doesn't have, downloads and reading statistics stay.

What the status means #

Sync's status icon sits in the app bar of Library, Updates, History and Statistics, or at the foot of the side dock in a wide window, and opens the Sync page. When sync stops until you act, a message on the screen you're on says why. On the Sync page, Live after the account means changes from other devices arrive as they happen.

The Sync page says What to do
Can't reach the server Check the connection and that the server is running. Changes wait on the device and nothing is lost.
First download waits for Wi-Fi Connect to Wi-Fi, or turn on Use mobile data for covers, fonts and first download.
Syncing paused, or Changes wait for Wi-Fi Changes wait on the device. Turn off Pause syncing, or connect to Wi-Fi.
Live updates aren't working Changes from other devices come when you open Katari and every few minutes, not as they happen. Whoever runs the server lets WebSockets through its proxy, as HTTPS behind a reverse proxy describes.
Sync failed on this device Something on the device stopped the sync, not the connection. Sync now tries again; if it keeps failing, update Katari, and share crash logs from Settings › Advanced to report it.
The server needs a server update This version of Katari needs a newer server. Whoever runs it follows Update the server.
Update Katari to keep syncing, Update Katari to sync something, or synced changes wait for a Katari update Another device or the server is newer than this app. Update Katari on this device.
Catching the server up The server went back to an older copy, and this device is sending it what it's missing. Let it finish.
Your sync server was reset The server has no accounts now. Once its admin account exists again, Set it up again signs in, and this device fills the server in.
This device was removed, or the account was disabled The device keeps everything and works on its own. Sign in again when you want it back.

Remove a device or disconnect #

  • Under Devices on the Sync page, Remove another device. It stops syncing and keeps what it holds; it has to be linked again to rejoin.
  • Rename this device to change the name your other devices show.
  • Disconnect this device stops it syncing. Its library, history and settings stay, and your account and other devices carry on.
  • If the server moved to a new address, enter it under Server address; the device stays signed in when the same server answers there.

Deleting your synced data or your account is done on the server's web page, under My account.