7 min read

How to Setup and Use Logseq Sync

How to Setup and Use Logseq Sync

Securely syncing your Logseq graph between devices can be challenging.

Until now.

We've heard your concerns loud and clear. We understand that you don't want to send your notes to cloud providers that could potentially read your data. Or what about the endless sync conflicts on services like iCloud and Dropbox?

That's why we've been working on our own sync service, offering end-to-end encryption so don't have to trust anyone with the keys to your data (not even us).

We've been testing Logseq Sync with a small group of testers and our Sponsors (those who donate more than $15 per month). Now that we've solved some important challenges, we're ready to give more people access to our Sync service!

From today onward, all of our Sponsors and Backers (those who donate $5 per month) have access to Logseq Sync. Please note that while it's a public beta, it's still very much a beta test.

In this article, you'll learn how to get access to Logseq Sync, how to setup your first remote graph, and what to keep in mind when using Sync.

How to get access to Logseq Sync

During the beta test, we're giving all of our active Open Collective contributors access to Logseq Sync. That means you need to have monthly recurring donation of either $5 per month or $15 per month. We'll implement a normal subscription system once we launch Sync to the general public.

Do not donate as Incognito or as a company on Open Collective. If you do, there's no way for our authentication system to see that you donated. In case you did donate incognito, register for Open Collective with the same email address you used to donate. If you registered as a company or run into issues, please contact us.

Please allow up to an hour for Open Collective to sync up with our authentication system. In the meanwhile, you can continue by activating the Sync feature and creating your Logseq account (see the steps below).

For Logseq Sync to work properly, you must run at least version 0.8.12 of Logseq desktop or mobile. Click here for the Desktop and Android app, and click here for the iOS app.

How to activate the Sync feature

Before you enable Logseq Sync, you first need to make a backup of the graph you wish to sync and move it out of any synced folder. Don't skip this step, otherwise you might lose some of your notes.

A synced folder is anything that a third-party service like iCloud or Dropbox monitors and backs up to the cloud. From now on, only Logseq Sync should be syncing your graph.

If you're using Logseq on iOS, make sure that your store the graph in the Logseq folder on your iPhone or iPad. If you store the graph outside of the Logseq folder, you won't be able to use Sync. Don't see the local Logseq folder? Restarting your iOS device will solve the issue.

Once you've ensured your Logseq graph runs fully local, it's time to enable the experimental Sync feature. To do so, go to Settings > Features and enable the Sync toggle. This works on Logseq Desktop, Android, and iOS. However, we strongly urge you to setup your first remote graph using the desktop app.

Don't see the toggle? Make sure you're on the latest version(>= 0.8.12). If you're on iOS, make sure you're on the latest App Store version, not the TestFlight version.

Whiteboards are currently only available for Sponsors.

Next, click the Login button. You'll see a small window pop up with two tabs: Sign In and Create Account.

Click the Create Account tab and fill in the form to create your account. Make sure to use the email address you used on Open Collective.

When you've chosen a username and a secure password, click the Create Account button and confirm your account using the verification code you received via email:

Finally, login and return to Logseq.

If you've just turned Sponsor or Backer, please allow up to an hour for the system to check your credentials and give you access to the next step.

If you haven't received a verification email within 10 minutes (first check your spam folder), please contact us and provide your email address and username.

How to setup a remote graph

To create a remote graph and start syncing your graph, click the cloud icon in the top menu bar:

Don't see the cloud icon? Make sure you have a (local) graph open.

Next, you're prompted to setup a new remote graph. Click the Create remote graph button:

Finally, set a secure password for your graph (this is different from your account password!) and click the Submit button:

Note: Save your password in a secure place, because you can't change it later (nor can we change the password for you).

How to sync

Logseq will automatically keep your graph in sync. When the dot in the cloud icon (in the top bar) is green, it means your graph is fully synced to the cloud. When the dot is orange, it means there are pending changes (either outgoing or incoming).

On mobile, Logseq will sync every two seconds after your stop typing. On desktop, it's currently set to sync 20 seconds after your stop typing.

If you want to force a sync, click the cloud icon and then the Sync now button:

At the moment, it's important to keep an eye on the sync status. When you open Logseq, let it first sync before starting to type. Otherwise, you might run the risk of overwriting notes in the cloud. That's because currently, Sync works different from Git; it does not compare pages. Instead, it syncs the entire page containing the most recent changes.

In case you do find yourself overwriting a remote change by accident, no worries. Logseq Sync keeps a page history for up to a year. You can access it by going to a page and clicking the Check page history button from the menu (...):

How to switch between remote graphs

Switching between remote and local graphs is easy. Simply switch graphs via the left sidebar (1) or the All graphs page (2). Remote graphs are indicated by the cloud icon behind their name:

When switching to a remote graph, you'll be prompted to enter its password (this is your graph password, not your account password):

That's it, happy syncing!

Storage limitations

During the beta test, these are the storage limitations:

  • Maximum number of remote graphs: 10
  • Maximum graph size (per graph): 10 gigabyte
  • Maximum asset size (per asset): 100 megabyte

Based on feedback and users' needs, we might change these limits at a later stage. We're also considering different storage tiers.

How to give feedback and get support

We’ve set up an exclusive feedback channel on Discord (join the server) so you can ask for help and give feedback. If you have the Backer or Sponsor role in Discord, you can access the private #beta-sync channel.

Don't have the Backer badge yet? See these instructions in Open Collective to claim it.

Want to know more?

In the coming weeks we'll release additional documentation about the new Sync service. If you have any specific questions, please send us a message and ask anything you'd like.

So far, questions range from what encryption technology we use (age) to the file version period (12 months), to what our plans are for monetization (we remain free and will only charge for pro services like sync, collaboration, and publish).

Feel free to ask anything that comes to your mind!

This is what we kindly ask from you

We're working hard to improve Sync with every release, but we need your help to do so. Here are three requests from us to you:

1) It’s not finished yet. At this stage of the Sync feature, there’s no reason to brag or complain on social media about it. Please send your feedback directly to us via email or Discord.

2) Tell us about your experience with this feature. Please drop a message in the #beta-sync channel with your feedback on how to make the Sync experience better for you.

3) This release is to hunt for bugs. Currently, the best way to help our developers do this is to record a video reproducing the bug. If you can’t reproduce the bug, the second best way is to share a screenshot and any console log errors.

As with most beta releases, there is less of a guarantee for data stability. So, make regular copies/backups of your graph folder, starting by creating a backup before you turn on Sync. Still, we hope to have as few losses as possible with this feature.

If you need help or have suggestions for the Sync feature, please join the #beta-sync channel in the Logseq Discord.