Skip to content

Lite docs: sync and backup - #81

Open
fylorn wants to merge 3 commits into
mainfrom
docs/sync-backup
Open

fylorn wants to merge 3 commits into
mainfrom
docs/sync-backup

Conversation

@fylorn

@fylorn fylorn commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

Waits for the Lite release that ships sync and backup; do not merge before. That release is ThinkWatch Lite 2026.10.25 with core 0.78.0, which the pages name as the minimum.

Summary

  • New page: Sync and backup (/docs/lite/sync-and-backup, English and Chinese), in Get started after Connecting to a remote core:
    • configuration packs (.twconfig) and backups: the last 10 versions on the device, the latest and the previous one in the sync location;
    • exporting and importing: keys included by default, optional passphrase encryption, per-item Overwrite / Import renamed / Skip for conflicts, plugins imported disabled, ChatGPT upstreams signed in again;
    • turning on sync with a folder, WebDAV or S3-compatible storage, and how to set up iCloud Drive, Dropbox, OneDrive, Google Drive, Jianguoyun (app password), Nextcloud, Synology, Cloudflare R2, Alibaba Cloud OSS, Tencent Cloud COS and MinIO, with generic endpoint formats;
    • encryption and what a lost passphrase means, what is synced (including upstreams not synced), merge units and conflicts, sync states, stopping sync;
    • restoring a whole version or only some items, safe mode, connected clients, remote cores, the twcore commands, and the table of what is never exported or synced.
  • Import links: a "Generated by Lite" section for the upstream Share dialog: keys included by default with the notice, what the link carries, and the configuration pack when the link would exceed 8192 characters.
  • Features: a Sync and backup section, the Share and Export selected entries under Upstreams, and the new settings section.
  • Overview, Connecting to a remote core, Architecture, FAQ: one-line updates where sync and backup changes what they say (the settings groups, history and rollback becoming backups, where data is kept and what the app connects to).
  • Sidebar entry and summaries in src/content/docs/_meta.ts.

Testing

  • Checked against core 0.78.0's configuration reference, release notes and twcore help, and the app's own strings in both languages.
  • pnpm build passes locally; every in-page and cross-page docs link with a fragment resolves.

🤖 Generated with Claude Code

fylorn and others added 3 commits October 19, 2026 00:38
A new page, Sync and backup, in English and Chinese: configuration packs,
backups on the device and in the sync location, exporting and importing
with keys optional, passphrase encryption and per-item conflict choices,
turning on sync with a folder, WebDAV or S3-compatible storage and how to
set up iCloud Drive, Dropbox, OneDrive, Jianguoyun, Nextcloud, Synology,
Cloudflare R2, Alibaba Cloud OSS, Tencent Cloud COS and MinIO, encryption,
what is synced, conflicts, sync states, restoring all or part of a
version, connected clients, remote cores, the twcore commands, and what
is never exported or synced.

Import links gains "Generated by Lite" for the upstream Share dialog.
Features, the overview, remote core, architecture and the FAQ mention
sync and backup where it changes what they say.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- The sync location's root is the folder, address or prefix itself;
  keyring, versions/ and devices/ sit directly in it.
- S3 addressing is chosen from the endpoint: virtual-hosted for
  amazonaws.com, aliyuncs.com and myqcloud.com, path style otherwise.
  Plain http:// is accepted only for local and private addresses on both
  WebDAV and S3, with a MinIO example; requests go direct, through the
  system proxy or an outbound proxy, and do not follow redirects.
- Upstreams with an OAuth refresh token keep their tokens on each device,
  like ChatGPT sign-ins: not exported or synced, kept on overwrite and
  restore.
- Packs from older versions are repaired on import and the preview lists
  the repairs; packs from newer versions ask for an update.
- The command-line section follows twcore's actual commands and options.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Needs ThinkWatch Lite 2026.10.25 (core 0.78.0 on a remote server).
- An encrypted location never takes plain versions or turns encryption
  off; a missing or older keyring, an emptied location and unusable sync
  settings pause syncing and offer "Upload this device's configuration"
  or "Stop syncing", never stopping by themselves. Turning encryption off
  keeps each device's passphrase.
- Joining takes the sync data's default gateway key and updates the
  clients connected on this device.
- Importing a pack without keys reuses this device's key only for the
  same destination; Rename never reuses keys, passwords or sign-ins.
- Upstream addresses with a backslash or credentials before the host are
  rejected; such a configuration opens in safe mode.
- Oversized general preferences are skipped in sync; partial restores
  keep or bring along referenced items; upstream, route and plugin order
  merge as units; local http:// locations go direct; bucket and prefix
  rules; twcore sync republish.
- UI labels in both languages follow the app's own strings, including
  config pack, Rename, Entire config, Included, Change passphrase and
  the Chinese name for groups.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant