diff --git a/README.md b/README.md index 2f59836..2832a82 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ A one fits all backup solution that solves modern problems with modern solutions +Available in both CLI / GUI flavors for both system administrators and end users + ## Features - Data deduplication and fast zstd compression @@ -52,7 +54,7 @@ So, a new backup solution out of nowhere, packed with too much features for it's NPBackup relies on the well known [restic](https://restic.net) backup program, which has been battle proven for years. While restic is a fanstastic program, NPBackup tries to complete restic in order to offer a broader user experience. -## Quickstart +## Quickstart CLI On Windows, use `NPBackupInstaller.exe` to install NPBackup into program files. On Linux, just copy `npbackup` to `/usr/local/bin` @@ -73,6 +75,28 @@ The GUI allows an end user to check current backups & restore files.rom backups: The YAML configuration file encrypts sensible data so the end user doesn't have to know repository URI or password. +## Quickstart GUI + +Just run the npbackup executable and configure it. + +![image](img/interface_v2.1.0.png) +Main minimalistic interface allows to: + - List current backups + - Launch a manual backup + - See if last backup is recent enough + +![image](img/restore_window_v2.1.0.png) +Restore window allows to browse through backups and select what files to restore. + +![image](img/configuration_v2.1.0.png) +Configuration allows to edit the YAML configuration files directly as end user + +**Security Note** +Please note that right clicking on "" in the configuration GUI will allow to decrypt that data, by prompting a backup admin password. +That password is set at compile-time and should be different depending on the organization. + +This allows a system admin to see repo URI and passwords, without leaving this information available on the computer. + ### The difficulty of laptop backups As a matter of fact, laptop backups are the hardest. No one can predict when a laptop is on, and if it has access to internet. diff --git a/img/configuration_v2.1.0.png b/img/configuration_v2.1.0.png new file mode 100644 index 0000000..e609477 Binary files /dev/null and b/img/configuration_v2.1.0.png differ diff --git a/img/interface_v2.1.0.png b/img/interface_v2.1.0.png new file mode 100644 index 0000000..6a216da Binary files /dev/null and b/img/interface_v2.1.0.png differ diff --git a/img/restore_window_v2.1.0.png b/img/restore_window_v2.1.0.png new file mode 100644 index 0000000..a8be9b0 Binary files /dev/null and b/img/restore_window_v2.1.0.png differ