A local-first personal finance app
Update sync.md (#546)
bpaulienf2ad60f12efe
diff --git a/docs/getting-started/sync.md b/docs/getting-started/sync.mdindex 6da3eb9a6a..5ef5f313ed 100644--- a/docs/getting-started/sync.md+++ b/docs/getting-started/sync.md@@ -6,21 +6,21 @@ We don't want to throw away the internet though. It's too useful. You can set upThat's why we automatically sync all of your data to your selected server in the background. You get the best of both worlds: all data is local by default, but if internet is available, your data is seamlessly backed up and synced to all other devices. This is the opposite of most apps which heavily rely on the internet to be available.-For the super privacy-focused, it even allows for your data to be end-to-end encrypted so that all your server is doing is passing around changes.+For the super privacy-focused, it even allows for your data to be end-to-end encrypted so that all your server is doing is passing around changes that you make to your budget.-## Getting started+## Getting StartedOnce you are logged in, if you have not created a file yet it will automatically create one for you. Go ahead and poke around the app and start setting up your budget.-If you have already created files, after logging in Actual will show you all the available files. Select one and it will download it and start syncing seamlessly. That's it.+If you have already created files, after logging in Actual will show you all the available budget files. Select one and it will download that budget and start syncing seamlessly. That's it.-## End-to-end encryption+## End-to-End Encryption-In addition to the requirement to enter your password before the Actual server will allow you to access your budget, you can optionally enable end-to-end encryption. This will mean that you’ll have to enter a second password to access the budget, and that the server will no longer be able to access your budget information. On the one hand, this improves security if you’re worried that someone else will have access to the server’s file or if you don’t trust the server to check the password correctly (that said, we have done our best to make the server secure). On the other hand, you **will not be able to recover your data if you forget your encryption password**. If you forget the encryption password and you still have a copy of your data locally, you can reset your key which will do a [sync reset](#what-does-resetting-sync-mean) and generate a new key.+In addition to the requirement to enter your password before the Actual server will allow you to access your budget, you can optionally enable end-to-end encryption. This will require you to enter a second password to access the budget, and that the server will no longer be able to access your budget information. On the one hand, this improves security if you’re worried that someone else will have access to the server’s file or if you don’t trust the server to check the password correctly (that said, we have done our best to make the server secure). On the other hand, you **will not be able to recover your data if you forget your encryption password**. If you forget the encryption password and you still have a copy of your data locally, you can reset your key which will do a [sync reset](#what-does-resetting-sync-mean) and generate a new key.End-to-end encryption offers the ability for you to generate a key based on a password and encrypt it so that hosted services can't read the data. Before your data leaves your device, it is encrypted using keys only you have.-This guarantees that only you will ever have access to your data. This is optional and using it requires you to enter a password whenever downloading [cloud files](#this-file-is-not-a-cloud-file) (this only needs to be done once per device). The password you enter can be different from the main server password.+This guarantees that only you will ever have access to your data. This is optional and using it requires you to enter a password whenever downloading [cloud files](#this-file-is-not-a-cloud-file) (this only needs to be done once per device). The password you enter should be different from the main server password.Data on your local device is still unencrypted. We recommend full disk encryption if you are interested in local encryption.@@ -35,19 +35,19 @@ There are some things to consider with end-to-end encryption:Note: even if you don’t have the password, you can still remove an encrypted file from the server.-### Setting up end-to-end encryption+### Setting up End-to-End Encryption-You can enable end-to-end encryption by opening a file, going into settings, and clicking "enable encryption" in the Encryption section. You will be asked to enter a password, and a key will be generated from it that will encrypted all your data from then on.+You can enable end-to-end encryption by opening a budget file, going into settings, and clicking "enable encryption" in the Encryption section. You will be asked to enter a password, and a key will be generated from it that will encrypt all your data from then on.When downloading data on other devices, you will need to enter the same password to generate the key to be able to decrypt your data.**Do not lose this password**. You will not be able to recover your data if you forget it. If you forget it and you still have a copy of your data locally, you can reset your key which will do a [sync reset](#what-does-resetting-sync-mean) and generate a new key.-## What does "resetting sync" mean?+## What Does Resetting Sync" Mean?There are many reasons why you might want to "start fresh" with syncing. This doesn't mean you lose any of your local data, but it means for one reason or another you want to forget about all synced data and start as if the current version of your file is the "true" version of it.-Since your data is local to each device and they all might not be up-to-date, **choose the right device** from which to reset sync. The usually won't matter, but it's important to realize that when you reset sync from one device, all un-synced changes from other devices will be reverted. Usually files are kept in sync recent enough that this isn't a problem. But if you happen to have a lot of changes that haven't been synced from one device (maybe it wasn't connected to the internet), make sure to do the sync reset from that device so it be comes the "true" version of your data.+Since your data is local to each device and they all might not be up-to-date, **choose the right device** from which to reset sync. This usually won't matter, but it's important to realize that when you reset sync from one device, all un-synced changes from other devices will be reverted. Usually file sync happens often enough that this isn't a problem. But if you happen to have a lot of changes that haven't been synced from one device (maybe it wasn't connected to the internet), make sure to do the sync reset from that device so it becomes the "true" version of your data.A few scenarios where you want a sync reset:@@ -55,38 +55,38 @@ A few scenarios where you want a sync reset:- You turn on end-to-end encryption. If you do this, the server needs to forget about any unencrypted data it already knows about. This requires starting fresh.- In the worst case scenario, you have data that is out of sync. This should never happen, but just in case it ever does, you can manually reset sync from the file that you want to treat as the "true" version.-Resetting sync will clear all syncing data from the server, upload your existing data as the "true" version, and your device gets a new "sync id". All devices syncing data must have the same sync id.+Resetting sync will clear all syncing data from the server, upload your existing data as the "true" version, and provide your device with a new "sync id". All devices syncing data must have the same sync id.After resetting, all other devices are now out-of-date. What happens when you try to run them? Actual will detect that syncing has been reset and tell you that they need to be reverted. Reverting a file will delete the local data, download the latest version of it, and assign the latest sync id generated by the reset. It will happily sync from then on.**Actual will always guide you through this**. It tracks the status of all your files and will notify you if something is wrong and give you steps to fix the problem. If you want to manually reset sync, you can do that in settings.-## Debugging sync issues+## Debugging Sync IssuesWhen Actual detects a problem during syncing, you will see a notification with details and actions to solve the problem. Below are all the notifications you might see, with some greater detail about them.**You will rarely see these messages**, and if you do Actual will guide you through how to fix the problem. If you are still having problems, please [reach out to us](/contact)-### This file is not a cloud file+### This File is not a Cloud FileA "cloud file" is a file that has been registered with your server and is currently syncing data. Sometimes a file hasn't been registered yet so it can't send any data to sync.-Usually this happens when a new file is created when there is no internet connection. In that case, it creates a local file but the server doesn't know anything about it. When you are online you need to register it.+Usually this happens when a new file is created with no internet connection available. In that case, it creates a local file but the server doesn't know anything about it. When you are online you need to register it.-### Syncing has been reset on this cloud file+### Syncing Has Been Reset on This Cloud FileIf you reset sync on a device, all other devices will see this message when they try to sync. When you reset sync, it deletes all syncing data from our server (but not any local data) and treats your local file as the "true" version. Because all the syncing data has been reset, other devices cannot sync anymore.-When this happens, on other devices you will see an option to revert to the latest version. Simply reverting will get you syncing again. See [What does "resetting sync" mean?](#what-does-resetting-sync-mean)+When this happens, on other devices you will see an option to revert to the latest version. Simply reverting will get you syncing again. See [What Does "Resetting Sync" Mean?](#what-does-resetting-sync-mean)-### File needs upload+### File Needs UploadSomething must have gone wrong when doing a sync reset. This shouldn't ever really happen, but in the off chance that you see this message, click "Upload" to upload your data to fix it.-### Your data is out of sync+### Your Data is Out of SyncUnfortunately, Actual detected an inconsistency in your synced data. This only happens if there is a bug in the syncing process, and you should never see this. If it ever does happen, doing a [sync reset](#what-does-resetting-sync-mean) will fix it.-### Update required+### Update RequiredWhile syncing, your device received data that it couldn't apply because your version of Actual is out-of-date. You need to update Actual and it will then sync successfully.