From b95b50483f478ae3087bc4eb13d5ee668759f199 Mon Sep 17 00:00:00 2001 From: def Date: Fri, 17 Nov 2023 02:28:30 +0200 Subject: [PATCH 1/4] docs: upd eng backups --- content/en/docs/Backups/_index.md | 67 +++++++++++++++---------------- 1 file changed, 33 insertions(+), 34 deletions(-) diff --git a/content/en/docs/Backups/_index.md b/content/en/docs/Backups/_index.md index ec08393..26cf9e7 100644 --- a/content/en/docs/Backups/_index.md +++ b/content/en/docs/Backups/_index.md @@ -11,85 +11,84 @@ description: > When your service is broken but it worked yesterday you have two options: - * Spend some time reading logs and debugging what went wrong. Meanwhile the service is unusable and maybe some data is irreversibly lost. - * Rewind the service to the working state and then debug at a more relaxed pace. Hopefully it was just solar flare or a glitch in the Matrix. + * Spend some time reading logs and debugging what went wrong. Meanwhile the service is unusable and maybe some data is irreversibly lost; + * Restore the service to a working state and then debug at a more relaxed pace. Hopefully it was just solar flare or a glitch in the Matrix. This second, nerve-saving option is enabled by backing up regularly, and even better, automatically. -As an extra benefit, backing up makes it easy to transfer a service from one machine to another with minimal hassle. -This is useful for datacenters on fire, if your server provider gets bought out by another corporation or if shareholders decide that it is finally time to make more profit. +As an extra benefit, backup makes it easy to transfer a service from one machine to another with minimal hassle. +This is useful for datacenters on fire, if your server provider gets bought out by another corporation, or when shareholders decide that it is finally time to make more profit. -This document covers the basic terms and usage of SelfPrivacy backup subsystem. +We cover the basic terms and usage of the SelfPrivacy backup subsystem. ## What is a snapshot? SelfPrivacy does not make backups of the whole machine. Instead, it saves the states of each service. -The state of files used by a service, taken at a certain time, is called a Snapshot. -In the interface, you can see a snapshot as having an id, a service it backs up, and a date of creation. +The state of the files used by a service, taken at a certain time, is called a Snapshot. +In the interface, you can see that a snapshot has an ID, a service it backs up, and a date of creation. ## When backups occur? A snapshot is created in 3 cases: - * By user's manual command to back up a service - * Automatically at certain intervals if Automatic Backups are enabled - * As a precaution before an inplace restore of a service + * By user's manual command to back up a service; + * Automatically at specified intervals if Automatic Backups are enabled; + * As a precaution before an inplace restore of a service. ## How the data is stored? -The service's files are stored at the cloud of user's choosing. -At the moment we support Backblaze but more are to be added. +The service's files are stored at the cloud of the user's choice. +We currently support Backblaze, but more will be added. -All of the service data is encrypted with a local secret which the cloud never receives. -Under the hood, we use Restic for transfers of encrypted data. +All of the service data is encrypted with a local secret that the cloud never receives. +Under the hood, we use Restic to transfer of encrypted data. -Clouds like Backblaze have an option to disallow immediate removal of data. +Cloud storage providers like Backblaze have an option to disallow immediate deletion of data. SelfPrivacy app uses this option so that in case when the server is hacked the data cannot be erased. ## Listing snapshots There are 2 factors to keep in mind when looking at the list: - * For the sake of performance, the list is cached. If some snapshots are missing which you think should be there, invalidate the cache so it reloads. - * If you remove some snapshots, they will disappear from the list, but for some limited time they are still restorable with the help of the cloud. + * For the sake of performance, the list is cached. If some snapshots are missing which you think should be there, invalidate the cache so it reloads; + * If you delete some snapshots, they will removed from the list, but for some limited time they are still restorable with the help of the cloud. ## Restoring a snapshot -When you restore a snapshot, the service is stopped, and all of its files are restored to the state when the snapshot was taken. -There are 2 ways to do it. +There are two ways to restore a snapshot, which stops the service and restores all files to the state when the snapshot was taken. The safest one, the default one, is to download the snapshot in its entirety, verify that data is not damaged, and replace the service files with the files from the snapshot. -This has a downside that you need to have extra space to store the snapshot. +However, this method requires additional storage space for the snapshot. -A somewhat riskier way is to overwrite the service files directly, without intermediate storage. This needs less space, but if the transfer goes wrong, you end up with a broken service. -To somewhat mitigate this, a pre-restore snapshot is made just before the restoration. +A somewhat riskier way is to overwrite the service files directly, without intermediate storage. It requires less space, but if the transfer goes wrong, you end up with a broken service. +To help reduce the impact, a snapshot is taken just before restoring. The app does check that we have enough space before attempting a restore. ## Forgetting a snapshot -Forgetting makes the snapshot inaccessible from the server, but deletion itself is reversible from cloud UI for some time (30 days for Backblaze by default). +If the snapshot is forgotten, it becomes inaccessible from the server, but deletion itself is reversible from cloud UI for some time (30 days for Backblaze by default). ## Automatic Backup -If you set up an automatic backup period, all of the services will be backed up regularly according to the period. +If you set up an automatic backup period, all of the services will be backed up based on the set period. Note that backups are independent per service. If you have services A and B backed up automatically every day in the morning, and then you back up service B manually at noon, then service A's next backup will be in the morning as usual, but B's backups will occur at noons. -If set to zero, autobackups will be disabled. +If it disable, automatic backups will not be performed. ## Restoring after someone has deleted all the snapshots - * Go to your Backblaze/other cloud interface directly. - * Rewind the bucket's state to prior the deletion event. - * Open SelfPrivacy app - * Invalidate snapshot cache - * List the snapshots - * Restore from snapshots as usual + * Go to your Backblaze/other cloud interface directly; + * Rewind the bucket to its previous state before the deletion event occurred; + * Open SelfPrivacy app; + * Invalidate snapshot cache; + * List the snapshots; + * Restore from snapshots as usual. ## Troubleshooting backups - * If you suspect that the snapshot list is inaccurate, try discarding the cache - * If an inplace restore failed, make sure that your cloud is accessible and your contract is active, then try to either restore a snapshot you tried to restore, or a pre-restore snapshot generated automatically - * If you do not have enough space on the disk for a safe restore, try restoring inplace + * If you suspect that the list of snapshots is incorrect, try clearing the cache; + * If an inplace restore has failed, make sure that your cloud is accessible and your contract is active. Then try to either restore a snapshot you tried to restore, or a pre-restore snapshot that was automatically generated; + * If you do not have enough space on the disk for a safe restore, try restoring inplace. -- 2.42.0 From 4d293732e83dc1b575eb435dc3558fa9000f069b Mon Sep 17 00:00:00 2001 From: def Date: Fri, 17 Nov 2023 02:34:49 +0200 Subject: [PATCH 2/4] docs: change button naming --- content/en/docs/Backups/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/Backups/_index.md b/content/en/docs/Backups/_index.md index 26cf9e7..5af6b9b 100644 --- a/content/en/docs/Backups/_index.md +++ b/content/en/docs/Backups/_index.md @@ -83,12 +83,12 @@ If it disable, automatic backups will not be performed. * Go to your Backblaze/other cloud interface directly; * Rewind the bucket to its previous state before the deletion event occurred; * Open SelfPrivacy app; - * Invalidate snapshot cache; + * Update the snapshot list; * List the snapshots; * Restore from snapshots as usual. ## Troubleshooting backups - * If you suspect that the list of snapshots is incorrect, try clearing the cache; + * If you suspect that the list of snapshots is incorrect, try to update snapshot list; * If an inplace restore has failed, make sure that your cloud is accessible and your contract is active. Then try to either restore a snapshot you tried to restore, or a pre-restore snapshot that was automatically generated; * If you do not have enough space on the disk for a safe restore, try restoring inplace. -- 2.42.0 From d5df6fcc4451b562903f7213841b88da338b91dc Mon Sep 17 00:00:00 2001 From: dettlaff Date: Mon, 27 Nov 2023 00:31:14 +0400 Subject: [PATCH 3/4] docs: fix from review --- content/en/docs/Backups/_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/Backups/_index.md b/content/en/docs/Backups/_index.md index 5af6b9b..3d10cef 100644 --- a/content/en/docs/Backups/_index.md +++ b/content/en/docs/Backups/_index.md @@ -16,10 +16,10 @@ When your service is broken but it worked yesterday you have two options: This second, nerve-saving option is enabled by backing up regularly, and even better, automatically. -As an extra benefit, backup makes it easy to transfer a service from one machine to another with minimal hassle. +Having a backup simplifies the process of transferring a service between machines, ensuring minimal inconvenience. This is useful for datacenters on fire, if your server provider gets bought out by another corporation, or when shareholders decide that it is finally time to make more profit. -We cover the basic terms and usage of the SelfPrivacy backup subsystem. +This document covers the basic terms and usage of SelfPrivacy backup subsystem. ## What is a snapshot? @@ -52,7 +52,7 @@ SelfPrivacy app uses this option so that in case when the server is hacked the d There are 2 factors to keep in mind when looking at the list: * For the sake of performance, the list is cached. If some snapshots are missing which you think should be there, invalidate the cache so it reloads; - * If you delete some snapshots, they will removed from the list, but for some limited time they are still restorable with the help of the cloud. + * If you delete some snapshots, they will be removed from the list, but for some limited time they are still restorable with the help of the cloud. ## Restoring a snapshot @@ -68,7 +68,7 @@ The app does check that we have enough space before attempting a restore. ## Forgetting a snapshot -If the snapshot is forgotten, it becomes inaccessible from the server, but deletion itself is reversible from cloud UI for some time (30 days for Backblaze by default). +Forgetting makes the snapshot inaccessible from the server, but deletion itself is reversible from cloud UI for some time (30 days for Backblaze by default). ## Automatic Backup @@ -81,7 +81,7 @@ If it disable, automatic backups will not be performed. ## Restoring after someone has deleted all the snapshots * Go to your Backblaze/other cloud interface directly; - * Rewind the bucket to its previous state before the deletion event occurred; + * Rewind the bucket to its previous state before the deletion event; * Open SelfPrivacy app; * Update the snapshot list; * List the snapshots; -- 2.42.0 From 36cef6e7a9e7cae74f4b3998fb499660dcfd13bb Mon Sep 17 00:00:00 2001 From: dettlaff Date: Thu, 15 Feb 2024 02:53:15 +0400 Subject: [PATCH 4/4] docs: fix from review --- content/en/docs/Backups/_index.md | 22 +++++++++++----------- content/ru/docs/Backups/_index.md | 1 - 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/content/en/docs/Backups/_index.md b/content/en/docs/Backups/_index.md index 3d10cef..1f6364d 100644 --- a/content/en/docs/Backups/_index.md +++ b/content/en/docs/Backups/_index.md @@ -12,12 +12,12 @@ description: > When your service is broken but it worked yesterday you have two options: * Spend some time reading logs and debugging what went wrong. Meanwhile the service is unusable and maybe some data is irreversibly lost; - * Restore the service to a working state and then debug at a more relaxed pace. Hopefully it was just solar flare or a glitch in the Matrix. + * Restore the service to a working state and then debug at a more relaxed pace. Hopefully it was just a solar flare or a glitch in the Matrix. This second, nerve-saving option is enabled by backing up regularly, and even better, automatically. Having a backup simplifies the process of transferring a service between machines, ensuring minimal inconvenience. -This is useful for datacenters on fire, if your server provider gets bought out by another corporation, or when shareholders decide that it is finally time to make more profit. +This is useful if your datacenter is on fire, if your server provider gets bought out by another corporation, or when shareholders decide that it is finally time to make more profit. This document covers the basic terms and usage of SelfPrivacy backup subsystem. @@ -39,12 +39,13 @@ A snapshot is created in 3 cases: ## How the data is stored? The service's files are stored at the cloud of the user's choice. -We currently support Backblaze, but more will be added. +We currently support Backblaze, with more to come. All of the service data is encrypted with a local secret that the cloud never receives. -Under the hood, we use Restic to transfer of encrypted data. +Under the hood, we use Restic to transfer encrypted data. + +Cloud storage providers, such as Backblaze, have an option to prevent immediate deletion of data. -Cloud storage providers like Backblaze have an option to disallow immediate deletion of data. SelfPrivacy app uses this option so that in case when the server is hacked the data cannot be erased. ## Listing snapshots @@ -56,7 +57,7 @@ There are 2 factors to keep in mind when looking at the list: ## Restoring a snapshot -There are two ways to restore a snapshot, which stops the service and restores all files to the state when the snapshot was taken. +Restoring a snapshot involves stopping the service and reverting all files to their state at the snapshot's creation. This process can be accomplished in two distinct ways. The safest one, the default one, is to download the snapshot in its entirety, verify that data is not damaged, and replace the service files with the files from the snapshot. However, this method requires additional storage space for the snapshot. @@ -72,11 +73,11 @@ Forgetting makes the snapshot inaccessible from the server, but deletion itself ## Automatic Backup -If you set up an automatic backup period, all of the services will be backed up based on the set period. +If you set up an automatic backup period, all of the services will be backed up according to the set period. Note that backups are independent per service. If you have services A and B backed up automatically every day in the morning, and then you back up service B manually at noon, then service A's next backup will be in the morning as usual, but B's backups will occur at noons. -If it disable, automatic backups will not be performed. +If it is disabled, automatic backups will not be performed. ## Restoring after someone has deleted all the snapshots @@ -84,11 +85,10 @@ If it disable, automatic backups will not be performed. * Rewind the bucket to its previous state before the deletion event; * Open SelfPrivacy app; * Update the snapshot list; - * List the snapshots; * Restore from snapshots as usual. ## Troubleshooting backups - * If you suspect that the list of snapshots is incorrect, try to update snapshot list; - * If an inplace restore has failed, make sure that your cloud is accessible and your contract is active. Then try to either restore a snapshot you tried to restore, or a pre-restore snapshot that was automatically generated; + * If you suspect that the list of snapshots is incorrect, try updating the snapshot list; + * If an inplace restore has failed, make sure that your cloud is accessible and your contract is active. Then try to restore either a snapshot that you tried to restore or a pre-restore snapshot that was automatically generated; * If you do not have enough space on the disk for a safe restore, try restoring inplace. diff --git a/content/ru/docs/Backups/_index.md b/content/ru/docs/Backups/_index.md index e99060c..69658ad 100644 --- a/content/ru/docs/Backups/_index.md +++ b/content/ru/docs/Backups/_index.md @@ -86,7 +86,6 @@ SelfPrivacy не создает резервных копий всей маши * Откатите состояние ведра до состояния, предшествовавшего удалению; * Откройте приложение SelfPrivacy; * Обновите список копий; - * Откройте снимки; * Восстановите моментальный снимок обычным способом. ## Устранение неполадок при резервном копировании -- 2.42.0