Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: supermemo/SuperMemoBackup
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 0.1-alpha
Choose a base ref
...
head repository: supermemo/SuperMemoBackup
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
  • 15 commits
  • 3 files changed
  • 1 contributor

Commits on May 5, 2018

  1. Update README.md

    alexis- authored May 5, 2018
    Copy the full SHA
    298d9a2 View commit details
  2. Update README.md

    alexis- authored May 5, 2018
    Copy the full SHA
    0e87de8 View commit details
  3. Update README.md

    alexis- authored May 5, 2018
    Copy the full SHA
    19fbe50 View commit details

Commits on May 6, 2018

  1. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    67a40dd View commit details
  2. Banners

    alexis- committed May 6, 2018
    Copy the full SHA
    88d62b6 View commit details
  3. Copy the full SHA
    8eb036e View commit details
  4. Banner

    alexis- committed May 6, 2018
    Copy the full SHA
    cdc3c7b View commit details
  5. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    a617562 View commit details
  6. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    353f64d View commit details
  7. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    6c1c451 View commit details
  8. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    e13ddfa View commit details
  9. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    5d046af View commit details
  10. Update README.md

    alexis- authored May 6, 2018
    Copy the full SHA
    2494e87 View commit details

Commits on May 7, 2018

  1. Update README.md

    alexis- authored May 7, 2018
    Copy the full SHA
    3192b54 View commit details

Commits on Oct 28, 2020

  1. Update README.md

    - Updated: Latest version
    alexis- authored Oct 28, 2020
    Copy the full SHA
    8ba586d View commit details
Showing with 30 additions and 9 deletions.
  1. +30 −9 README.md
  2. BIN Resources/BitShelter.Banner.png
  3. BIN Resources/BitShelter.BannerFull.png
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
## BitShelter

*BitShelter* is software that builds on [Microsoft's VSS technology](https://en.wikipedia.org/wiki/Shadow_Copy) to keep a version history of your files, and make external backups of them.
*BitShelter* a is software that builds on [Microsoft's VSS technology](https://en.wikipedia.org/wiki/Shadow_Copy) to keep a version history of your files, and make external backups of them.

Have you **deleted** a file by mistake ? Modified a document and wish to **revert** the **changes** ? Has one of your **drive failed** ? *BitShelter* has got you covered is all these cases !
Have you **deleted** a file by mistake ? Modified a document and wish to **revert** the **changes** ? Has one of your **drive failed** ? *BitShelter* has got you covered in all these cases !

**ATTENTION**: *BitShelter* is a **Work In Progress**, you may encounter bugs and not all features are available yet.

### Table of Content
- [Screenshots](#screenshots)
- [Features](#features)
- [Limitations](#limitations)
- [How does it work ?](#how-does-it-work-)
- [Requirements](#requirements)
- [Downloads](#downloads)
- [Installation and Usage](#installation-and-usage)
- [Requirements](#requirements)
- [Upgrading](#upgrading)
- [Best Practices](#best-practices)
- [FAQ](#faq)
- [Glossary](#glossary)
@@ -56,16 +58,34 @@ List of defined Rules | New rule: Advanced
### Limitations

- Up to [512 Snapshots](https://msdn.microsoft.com/en-us/library/bb891959.aspx?#maxshadowcopies) per Drive
- Encryption only works with Archives
- Encryption only work when combined with Archives
- [Manual one-time](#installation-and-usage) activation of Windows [System Protection](https://github.com/alexis-/BitShelter/raw/master/Resources/SystemPropertiesProtection_2018-05-05_13-10-18.png) on desired Drives

If you know a work-around for these limitations, please let me know [here](https://github.com/alexis-/BitShelter/issues) or by [email](mailto:alexis@incogito.org)

### How does it work ?

[![](https://github.com/alexis-/BitShelter/raw/master/Resources/BitShelter.Banner.png)](https://github.com/alexis-/BitShelter/raw/master/Resources/BitShelter.BannerFull.png)

Operation | Result | Location | Size | Speed
:---------------:|:-------------------------:|:------------:|:------------:|:------------:
**Snapshot** | This is *similar* to **Ctrl+Z** for files. Every time a snapshot is created, the system memorizes the content of your files. You can [browse](https://raw.githubusercontent.com/alexis-/BitShelter/master/Resources/explorer_2018-05-04_18-00-38.png), [view and restore](https://raw.githubusercontent.com/alexis-/BitShelter/master/Resources/explorer_2018-05-04_17-50-30.png) them to earlier versions. You can continue your work without interference during the process<sup>1</sup> | Same drive as data | As much as the difference between each consecutive snapshot | Almost instantaneous
**Backup** | This is *similar* to **Ctrl+C** and **Ctrl+V**: Backups create a *copy* of your files. They can be stored locally or remotely. You can optionaly archive them with compression (e.g. zip, tar.gz), and encrypt them. Because Backups operate on Snapshots, you can continue your work without interference during the process<sup>1</sup>. See [best practices](#best-practices) for recommendations | Local drive, Network drive, Removable device, ... | At most as much as the data, less if compressed | Minutes to hours depending on size, disk speed, compression, encryption
**Cloud sync** | While *BitShelter* knows nothing about Cloud Storage, you can use backups to create copies of your work in Sync folders of popular providers. They will in turn be sent to your space on the Cloud | In the cloud | As much as backups, only counting toward your Cloud Storage space | Minutes to hours, depending on size, upload speed

**<sup>1</sup>**: When a snapshot is created, existing data aren't copied. Instead, an index of where the data exist is built and new data written to free space. This is extremely fast, and allow to operate on snapshots concurrently with the "live data". For more information, see [Copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write)

### Requirements

- While *BitShelter* should run on any Windows higher or equal to **Vista**, as of now (2018-05-05) it has **only been tested on Windows 10**
- .NET 6.0.1 or higher (installed during Setup)
- Configured Devices in Windows **System Protection** (see [Installation and Usage](#installation-and-usage))

### Downloads

[**All releases**](https://github.com/alexis-/BitShelter/releases)

[**Latest version (installer)**](https://github.com/alexis-/BitShelter/releases/download/0.1-beta/BitShelter_v0.1-beta_Setup.msi)
[**Latest version (installer)**](https://github.com/supermemo/SuperMemoBackup/releases/download/0.1c-beta/BitShelterSetup-0.1.3.msi)

![](https://github.com/alexis-/BitShelter/raw/master/Resources/warning_24.png) **Make sure to follow the instructions** about ***System Protection*** and ***Raise limit***, see [Installation and Usage](#installation-and-usage)

@@ -84,11 +104,11 @@ If you know a work-around for these limitations, please let me know [here](https
* Press the **Create** button
* To make sure your settings are correct, [verify the snapshots](https://www.howtogeek.com/howto/11130/restore-previous-versions-of-files-in-every-edition-of-windows-7/) are properly created on selected Drives

### Requirements
### Upgrading

- While *BitShelter* should run on any Windows higher or equal to **Vista**, as of now (2018-05-05) it has **only been tested on Windows 10**
- .NET 6.0.1 or higher (installed during Setup)
- Configured Devices in Windows **System Protection** (see [Installation and Usage](#installation-and-usage))
*BitShelter* cannot Auto-Update itself yet. To upgrade to a newer version, please uninstall the existing application, and run the installer for the new version.

All your settings, snapshots and logs will be preversed.

### Best practices

@@ -146,6 +166,7 @@ Todo

I would like to emphasize on the importance of their contribution, and extend my gratitude especially to (but not limited to):
* *Peter Palotas* for his **incredible** [AlphaVSS](https://github.com/alphaleonis/AlphaVSS) (central piece of *BitShelter*)
* *Faan* for her **amazing** [banner](https://raw.githubusercontent.com/alexis-/BitShelter/master/Resources/BitShelter.BannerFull.png). She's open to new opportunities, if you're looking for talented designers please contact me [by email](mailto:alexis@incogito.org) !
* (todo)

All required licenses can be found at the root of this project repository.
Binary file added Resources/BitShelter.Banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Resources/BitShelter.BannerFull.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.