WebDAV Connection and encrypted sync

Applies to the current local test build of Hangrail. The steps below use macOS.

On this page

To keep using notes and screenshots from one computer on another, connect Hangrail to WebDAV storage. With sync enabled, both computers exchange encrypted content through your chosen server. No Hangrail account is needed.

Prepare connection details

You need a WebDAV-enabled service, an accessible folder URL, an account, and a server app password. For self-hosted services, the account needs read, write, and create permissions for the folder. Use HTTPS for internet connections.

Nutstore users can open “Account Information → Security Options” (账户信息 → 安全选项) on its website, add an app password under “Third-party App Management” (第三方应用管理), then enter the generated password in Hangrail. Use the third-party app authorization password, not your Nutstore web login password. See Nutstore's official authorization instructions.

First, distinguish these three passwords:

NamePurpose
Server app passwordLets Hangrail log in to the WebDAV server
Sync encryption passphraseEncrypts and decrypts the sync library; devices using the same library share this passphrase
Manual backup passwordProtects an independent backup; restoration requires that backup's original password

Changing the server login password does not reset the sync encryption passphrase.

Create a sync library on the first computer

  1. Open Hangrail's “Settings → Sync & Backup” (设置 → 同步与备份).
  2. Choose “Nutstore” (坚果云) or “Other WebDAV” (其他 WebDAV). Nutstore's server address is filled in for you. For other services, enter the final WebDAV folder URL.
  3. Enter your account and app password, then click “Connect & Continue” (连接并继续). This only checks the connection and existing sync library; it does not upload cards yet.
  4. If the server has no sync library, proceed to “Create Sync Library” (创建同步库). Generate a sync passphrase, save it somewhere safe or in a password manager, and select “I have saved my sync passphrase” (我已保存同步口令). You can instead enter a custom passphrase of at least 10 characters and confirm it.
  5. Select “Also sync ordinary files and videos” (同时同步普通文件与视频) if needed, then click “Create & Start Syncing” (创建并开始同步).

Once sync succeeds, Settings shows its status and the time of the last successful sync. First create a sample note with no sensitive information, wait for sync to finish, then connect the second computer.

Connect to the existing library on the second computer

On the second computer, open “Sync & Backup” (同步与备份), enter a URL pointing to the same sync library and valid server credentials, then click “Connect & Continue” (连接并继续). When “Connect to Existing Sync Library” (连接已有同步库) appears, enter the first computer's sync encryption passphrase and click “Connect & Start Syncing” (连接并开始同步). If credentials are already saved locally, you can choose “Use the sync passphrase saved on this device” (使用本机已保存的同步口令).

Once both computers report successful sync, check that the sample note appears. Edit it on the second computer, then confirm the change on the first. A successful server login alone does not mean sync is complete.

Check sync scope and retention

Text, notes, groups, pinned status, and images sync by default. A switch controls ordinary files and videos. Content received through Nearby Sharing stays local and is not automatically added to WebDAV sync.

Manual deletions and history retention periods sync to other devices using the same library. Shortening retention may clean up ordinary history locally and in cloud storage. Extending it later does not restore removed content. Keep an independent backup of materials you need long-term.

After pausing, click “Resume Sync” (继续同步). To check for new content manually, click “Sync Now” (立即同步). Turning off automatic sync keeps local cards.

Troubleshoot connection failures

Account or authorization failure: Check your account and app password first. Do not use Nutstore's web login password. For self-hosted services, also check folder permissions. If the server requires a redirect, enter the final WebDAV URL instead.

Connected, but sync cannot start: Check that the sync encryption passphrase matches the existing library. Some services do not support the secure update operations Hangrail requires. The app will stop syncing and show a reason. Do not overwrite the old folder to bypass these checks.

The first sync takes a long time: Attachment counts and provider request limits affect duration. If rate-limited, check the status message and wait for the cooldown rather than repeatedly retrying.

Forgotten sync passphrase: On a device that has connected before, expand “Forgot your sync passphrase?” (忘记同步口令?) and authenticate locally to view the saved passphrase. If all copies are lost, old cloud content cannot be decrypted. Preserve local content on every device first, then create a sync library in a new, separate WebDAV folder. Do not delete the old library to try resetting the password.

To send a few files to a nearby computer, use Nearby Sharing. To prepare for changing computers or keep an independently restorable copy, use Backup & restore.