1.0.0-beta1

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

Author: ArtificialOwl

Makefile

@@ -9,7 +9,7 @@ cert_dir=$(HOME)/.nextcloud/certificates
 github_account=nextcloud
 release_account=nextcloud-releases
 branch=master
-version=0.2.0
+version=1.0.0-beta1
 since_tag=
 
 all: appstore

README.md

@@ -2,6 +2,15 @@
 
 This App allows admin to create and store backup images of their Nextcloud
 
+
+- [Restoring Points](#restoring-point)
+- [How the Backup App manage your data](#backup-manage-data)
+- [Upload to External Storages](#external-storages)
+- [Important details about your data](#important)
+- [Available `occ` commands](#occ)
+
+
+<a name="restoring-point"></a>
 ## Restoring Points
 
 A restoring point is an image of your Nextcloud at a specific time. A restoring point can be:
@@ -55,9 +64,55 @@ The normal process is to re-create the `restoring-point.data` a new one, however
 - the restoring process will require some knowledge from the admin about the infrastructure from the
   original instance that generated the backup.
 
+<a name="backup-manage-data"></a>
+## How the Backup App manage your data
+
+### The timing
+
+The settings available in the Admin Settings/Backup page, allow an admin to configure when the next
+backups will be run and at which rate:
+ ...
+### The first pass (the backup process)
+ ...
+
+### The second pass (the packing process)
+ ...
+
+
+<a name="external-storages"></a>
+## Upload to External Storages
+
+
+<a name="important"></a>
+## Important details about your data
+
+- **Disk-space**: The 1st pass does not compress anything, meaning that you will need at least the
+  equivalent of currently used space by your Nextcloud as available disk-space.  
+  If you have no disk-space available, you can setup your instance to directly store your backup on an
+  external storage:
+    - the data generated during the 1st pass are not encrypted, Your data leaves the internal data folder
+      from your instance and are now available on an external storage.
+    - the 1st-pass will require more resource and your instance will stays in maintenance mode for a
+      longer time.
+    - If your external storage is not a local folder, huge network resources will be required.
+
+
+- **Temporary Files**: during the 2nd pass (packing process), the compression and encryption require the
+  creation of temporary files. while those files are temporary and deleted when they become useless, they
+  are still available for few seconds. Meaning that the temp directory should not be shared with other
+  application.
+
 
+- **Export your setup**: If the option is not disable, Backups are encrypted with a key that is stored in
+  the database of your current instance of Nextcloud. The key is mandatory to recover any data from your backups.
+  
+  You can export your setup from the Admin Settings/Backup page, or using `occ`. If encrypted, the export process will 
+  generate  and returns its own key that will be required during the import when restoring your instance.
+  As an admin, you will need to store the export file and its key, preferably in different location.
+  
 
-## Quick documentation:
+<a name="occ"></a>
+## Available `occ` commands:
 
 ### Manage remote instance to store your backups remotely
 

appinfo/info.xml

@@ -3,10 +3,22 @@
 	  xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd">
 	<id>backup</id>
 	<name>Backup</name>
-	<description><![CDATA[Backup now. Restore later.]]></description>
+	<summary>Backup now. Restore later.</summary>
+	<description>
+		<![CDATA[The Backup App allows admins to create and store backup images of their Nextcloud:
+	  - Backup the instance, its apps, your local data and your database,
+      - Admin can configure the time slots for automated backup,
+      - Full and Partial backup, with different frequencies,
+      - 2-pass to limit the downtime of your instance (maintenance mode),
+      - compression and encryption,
+      - upload your encrypted backup on an external filesystem,
+      - download and search for your data,
+      - restore single file or the complete instance
+]]>
+	</description>
+	<version>1.0.0-beta1</version>
 	<licence>agpl</licence>
 	<author mail="maxence@artificial-owl.com">Maxence Lange</author>
-	<version>23.0.0-alpha1</version>
 	<namespace>Backup</namespace>
 	<category>tools</category>
 	<website>https://github.com/nextcloud/backup</website>

composer.lock

@@ -100,5 +100,4 @@ public function export(bool $encrypted, string &$key = ''): string {
 
 		return $data;
 	}
-
 }