NOTEGEN.Sync
Sync through Git, S3, WebDAV, cloud folders, or an experimental self-hosted NoteGen service.
NoteGen supports GitHub, Gitee, GitLab, Gitea, S3, WebDAV, OneDrive, iCloud Drive, and experimental NoteGen self-hosting. The selected provider becomes the primary sync method.
Sync
Configure repositories for captures, Markdown files, and portable settings.
What is synced
| Data | Behavior |
|---|---|
| Markdown and assets | File-level upload, pull, delete, and delayed auto-sync after editing |
| Records, tags, chats, canvases, and settings | Manual or automatic structured-data upload/download with cross-device conflict detection |
Device-specific values such as workspace paths and UI scale are excluded. Exclude Sensitive Settings also removes tokens, passwords, image-host settings, MCP settings, and other private values.
Provider setup
GitHub / Gitee / GitLab / Gitea
Enter a token and repository name. GitLab and Gitea support self-hosted instances. NoteGen can create a private repository on supported platforms when it does not exist.
| Provider | Minimum permission for an existing repository | Additional permission to create one |
|---|---|---|
| GitHub | Fine-grained PAT with Contents read/write | Administration read/write; replace it with a repository-scoped token afterward |
| Gitee | user_info, projects | Same |
| GitLab | api | Same |
| Gitea | read:user, write:repository | write:user, write:repository; older versions may expose only all |
S3
Enter the access key ID, secret access key, region, bucket, endpoint, and optional path prefix. Compatible S3 object stores are supported. Save and test the connection before enabling automatic sync.
WebDAV
Enter the server URL, username, password, and optional path prefix. Synology, QNAP, Nextcloud, and other compatible servers can be used. HTTPS is recommended.
OneDrive / iCloud Drive
On desktop, choose a local sync folder managed by OneDrive, iCloud Drive, or another cloud-drive service. Android can grant access to a cloud folder through the system picker. On iOS, NoteGen can migrate the workspace into its iCloud Drive container. After migration, the cloud-drive service synchronizes Markdown and asset files between devices, while the original workspace remains as a safety copy.
iCloud Drive requires an Apple Account with iCloud Drive enabled. NoteGen never receives the Apple Account password and does not relay iCloud files through NoteGen servers.
NoteGen self-hosting (experimental)
After enabling Developer Mode, select the self-hosted provider, enter the deployed server URL, sign in or register, and associate the local workspace with a remote library. See Self-hosting for server deployment.
Self-hosted mode manages libraries, members, and devices and can separately control workspace files and personal-data synchronization. Before connecting, verify that:
- the URL uses trusted HTTPS;
- the recovery key is stored offline;
- the local workspace matches the intended remote library;
- the first transfer direction is clear and a local ZIP is available.
Self-hosted sync remains experimental. Pin versions and back up the database, object storage, and local workspace before client or server upgrades.
See Connect to a self-hosted NoteGen service for sign-in, libraries, member permissions, and conflicts.
Multiple workspaces and repository mapping
Git providers can map different local workspaces to separate repositories. After switching workspaces, verify the active mapping so two directories are not pushed into the same remote path. If system Git is unavailable, credentials expire, or the worktree is unhealthy, stop automatic sync and inspect diagnostics first.
Note auto-sync
Disable it or choose a delay from 2 seconds to 2 minutes after editing stops. NoteGen can also pull when a file opens or when switching files. Auto-pull can overwrite the local version, so enable it only after validating your workflow.
Records and settings auto-sync
Changes enter an ordered upload queue. The first time it is enabled, choose Upload Local, Pull Remote, or Later. A new device normally pulls remote data; back up a device with unsynced local data before choosing.
Resolve conflicts
- Merge both sides keeps new items from both sides, prefers the newer version of the same record, and merges settings under the current privacy rules.
- Pull remote over local discards unsynced local changes.
- Upload local over remote may discard changes from other devices.
Export a local ZIP from the title-bar sync menu before a high-risk overwrite.