Help Docs

Sync and Restore

Nokuo's local-sync folder, S3-compatible object storage, restore, and multi-device usage model.

Two sync options

Nokuo sync is built around encrypted Vault files. You can use a local-sync folder, or you can use S3-compatible object storage.

Local-sync folder

You can place the Vault inside iCloud Drive, OneDrive, Syncthing, Feiniu, NAS sync, or another local-sync folder.

This mode means:

  • Nokuo reads and writes only the local Vault folder.
  • Your sync tool copies encrypted Vault files between devices.
  • It fits users who already have a stable local sync workflow.

Finish the folder setup and prerequisites in Settings first. Once the page reaches the ready state, let the sync tool handle file copying.

Local sync settings ready

S3-compatible object storage

Object-storage sync is for users who need a smoother sync, restore, and history experience. Object-storage sync can use Amazon S3, Cloudflare R2, Aliyun OSS, MinIO, or another S3-compatible service.

In the desktop app, configure the endpoint, region, access key, secret key, bucket, and related fields. The sync target stores encrypted Vault files, not plaintext materials.

S3 storage settings page Filled S3 storage settings page

How to fill each provider

The key idea is the same field set across providers.

  • endpoint: object-storage service address
  • region: region name; some providers can infer it automatically
  • access key / secret key: credentials
  • bucket: target bucket

Common provider mappings:

ProviderChooseregionendpoint
Aliyun OSSSelect "Aliyun OSS"Use the real region, such as cn-beijing or cn-hangzhouUsually becomes https://oss-<region>.aliyuncs.com
AWS S3Select "AWS S3"Use the real region, such as us-east-1 or ap-southeast-1us-east-1 uses https://s3.amazonaws.com; other regions use https://s3.<region>.amazonaws.com
Tencent Cloud COSSelect "Tencent Cloud COS"Use the real region, such as ap-guangzhou or ap-shanghaiUsually becomes https://cos.<region>.myqcloud.com
Qiniu KodoSelect "Qiniu Kodo"Use the Qiniu region, such as cn-east-1 or ap-southeast-1Usually becomes https://s3-<region>.qiniucs.com
Volcengine TOSSelect "Volcengine TOS"Use the real region, such as cn-beijing or cn-shanghaiUsually becomes https://tos-s3-<region>.volces.com
Cloudflare R2Select "Cloudflare R2"Fill autoFill https://<ACCOUNT_ID>.r2.cloudflarestorage.com
Self-hosted / other S3-compatible serviceSelect "Self-hosted / S3-compatible"Follow the service requirements; if unsure, start with autoManually enter the S3-compatible endpoint provided by the service

Notes:

  • Cloudflare D1 is not S3-compatible object storage, so it does not belong in this sync flow.
  • If you use MinIO or another S3-compatible service on NAS or your own server, use "Self-hosted / S3-compatible".
  • If you only need a local sync folder, you do not need this section.

Restore flow

If you are moving to a new device, reinstalling, or writing a backup back to disk, the normal restore path uses the remote address, a local restore folder, and the master password. The recovery-key flow is only for forgotten passwords.

1. Open the restore page and enter the remote address

Start by opening the restore page, then pick the local restore folder.

Cloud restore page

2. Configure object storage

Fill in endpoint, region, access key, secret key, and bucket, then test the connection and load the remote Vault list.

If you have not configured the provider yet, use the table above. The restore page and the Settings page use the same field set.

Restore page object storage settings

3. Select the Vault to restore

Choose the Vault from the remote list and confirm the overwrite warning before starting restore.

Restore page remote Vault list

4. Unlock the restored Vault with the master password

After restore finishes, the app returns to the unlock screen. Use the master password here, not the recovery key.

Unlock page after restore

5. Use the recovery-key flow only if you forgot the password

Switch to the recovery-key flow only when the master password is lost. Verify the recovery key, then set a new password.

Recovery-key unlock page Reset-password page after recovery key

When object-storage sync makes sense

If you need more capacity, object-storage sync, restore, and history, this is the right path.

On this page