Mirrors/super-productivity
1
0
Fork 0
mirror of https://github.com/johannesjo/super-productivity.git synced 2026-07-18 17:05:48 +00:00
Code Issues Projects Releases Wiki Activity
super-productivity/docs/wiki/2.09-Configure-Sync-Backend.md
Corey Newton c2b18683d8
docs/wiki content v0.7 (#6568) 
* docs(wiki): add new Quickstart to help with using Sync

There is a slew of notes that try to explain or show this so a
Quickstart can help bring everything into one place.

* docs(wiki): combine "First Steps" into single note with relevant links

* docs(wiki): update index notes

* docs(wiki): fix remaining broken external links

* docs(wiki): add core developer How-To guides to orient first-time devs

The majority of the documentation is currently spread across several
files ins "docs/" and READMEs. Over time these can be consolidated into
the wiki while retaining the common CONTRIBUTING.md as a valid entry
point.

* docs(wiki): add basic guides for plugins and issue integration

As with the core development docs, there is too much to add here right
now. These notes will serve as a simple entry to other resources.

* docs(wiki): add basic reference note for theming

* docs(wiki): add basic Translation guide

* docs(wiki): rename Theming and linting to clean up headings

* docs(wiki): add heading lint exception for GH-specific nav pages; rework sidebar and index pages

Sidebar should be a quick-access for the more common topics grouped
thematically with the X.00 notes simply enumerating all the notes where
appropriate.
2026-02-20 21:13:38 +01:00

5.3 KiB
Executable file
Raw Blame History

Configure Sync Backend

For how to choose a provider, see 2.08-Choose-Sync-Backend. For where data and backups are stored, see 3.06-User-Data and 4.23-Managing-Your-Data. The sync form lives in the app under Settings → Sync & Backup tab → Sync section. The structure below matches the form in the codebase.

Where to Configure

  1. Open Settings (gear icon).
  2. Open the Sync & Backup tab.
  3. In the Sync section, enable Enable syncing and choose a Sync provider from the dropdown.

The rest of the form depends on the selected provider. Common options (sync interval, manual-only, encryption) are described after the per-provider sections.

SuperSync (Beta)

  • Info: The app shows a short note that SuperSync keeps your tasks in sync across devices in real time and that data is stored on the sync server. SuperSync is currently in Beta.
  • Get a token: Click Open Server & Get Token to open the server login page in your browser. After logging in, copy your access token.
  • Access Token: Paste the token into the Access Token field. Required for SuperSync.
  • Advanced: Under Advanced, you can set a custom Server URL (leave as-is for the official server). Here you can also Enable Encryption for end-to-end encryption; the app shows warnings about password loss and server data being replaced.
  • Encryption: If encryption is enabled, you can Change Password or Disable Encryption from the same form. These actions replace server data and require the same password on all devices (or re-upload with a new password).

SuperSync uses a fixed sync interval and does not show the Sync interval or Only sync manually options; those apply to file-based providers.

Dropbox

  • Authentication: When you select Dropbox, the app uses OAuth: you are taken to Dropbox to sign in and authorize the app. No Dropbox password is stored in the app; only tokens are kept.
  • Sync interval and Only sync manually appear (see below). Encryption is available under Advanced for file-based providers; you set a client-side encryption key so data in Dropbox can be stored encrypted.

WebDAV (experimental)

  • Info: The form shows that WebDAV implementations differ and that the app is known to work well with Nextcloud but may not work with every provider. In the browser, a CORS note may appear: you may need to allow the app to make CORS requests to your WebDAV server (e.g. via Nextcloud’s webapppassword app for the web app). Use at your own risk.
  • Base URL: Required. Example: https://your-nextcloud/nextcloud/remote.php/dav/files/yourUserName/.
  • Username and Password: Required for WebDAV.
  • Sync Folder Path: Path relative to the WebDAV server root where sync files are stored (e.g. /super-productivity or /). This is not your server’s internal filesystem path.
  • Sync interval and Only sync manually apply. Encryption is available under Advanced for file-based providers.

Local File (experimental)

Available on desktop (Electron) and Android only; not in the web app.

  • Info: The form states that local file sync stores data in a folder on your device and that you should not use file-syncing tools (e.g. Syncthing, Resilio) to sync that folder between devices—they can cause conflicts. For multi-device sync it recommends WebDAV, Dropbox, or SuperSync.
  • Sync folder path: Required. On desktop, use the Sync folder path button to open a folder picker and choose where the sync file is stored. On Android, use the same button to open the Storage Access Framework (SAF) and select the folder.
  • Sync interval and Only sync manually apply. Encryption is available under Advanced for file-based providers.

Common Options (Dropbox, WebDAV, Local file)

  • Sync interval: How often the app syncs automatically. Hidden for SuperSync and when “Only sync manually” is on.
  • Only sync manually (disable automatic sync): When checked, sync runs only when you trigger it (e.g. via the sync button). Shown only for file-based providers (Dropbox, WebDAV, Local file).

Encryption

  • SuperSync: Encryption is configured in the SuperSync block (Enable Encryption, Change Password, Disable Encryption). The server can store only encrypted data; you manage the password and must use the same password on all devices.
  • File-based (Dropbox, WebDAV, Local file): Under Advanced, you can Enable client-side encryption. You set an encryption key; the app encrypts data before sending it. The key is not sent to the provider. You must set the same key on every device before the next sync. If encryption is already enabled, the form shows that the password is set and offers Change Password or Disable Encryption (or Remove Encryption). Enabling or disabling encryption replaces data on the remote side (Dropbox file or WebDAV/local file) and affects all devices.

Related