bitferry 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07536a8e52281f9dbe3a085aa9bedff6164f116babcb163149e8a13e2214f771
-  data.tar.gz: a81dbb898d67e9c9e2083871c69bfd6396e56caa12904b085cf8e7c5e85248d5
+  metadata.gz: b3cf2cfbd34a736bdab0ca41d188a732b5e848be7a746ae9d351424e305ac59d
+  data.tar.gz: 42c91f3371a2c61afdc813870550d19341b2b2e0e8096b5ec2b41adb05fd0670
 SHA512:
-  metadata.gz: c8025822e4520ec87254036acd3b7c6f3933949b3a0737cc9d12d91d5ae4d5fa5d98487a9f2d60a18c15cfb9d4009212b35ead99ce415ececdc42b48c03bcd7f
-  data.tar.gz: 1af8e4d44dd64818f78eadb27b62233e33bd4f7f1cc493dfafbcb7ca4defd77e5ea868ad5060ee28e6eefc3f4c122842e7774b4627506305ee553e12157ea3c0
+  metadata.gz: 3c4f17e69351732f951a411bfc2f62f5052838abfa81d79655e9f6e5b9ee7826dc98a0b40005437d613155071fb71d028dcdddfb7bdcf8e29bd3e6a0ce022bcc
+  data.tar.gz: 64e48fa1d13e51f28c598ff57022d9d300b901a9db2b98af0b446bcfe540d6dd218e8da8d1b08a4ec7b2700af63b6e1d693d340685d49674f69b4004a30fd6d6

data/CHANGES.md

@@ -0,0 +1,13 @@
+## 0.0.3
+
+- Windows bundle
+- Doc fixes
+
+## 0.0.2
+
+- Fix infinite nesting of directories during GEM installation
+- Doc updates
+
+## 0.0.1
+
+- Initial release

data/README.md

@@ -1,4 +1,4 @@
-# Bitferry - file synchronization/backup automation tool
+# Bitferry - file synchronization/backup automation
 
 <div align="right"><i>Ein Backup ist kein Backup</i></div><br><br>
 
@@ -6,8 +6,9 @@ The [Bitferry](https://github.com/okhlybov/bitferry) is aimed at establishing th
 
 The intended usage ranges from maintaining simple directory copy to another location (disk, mount point) to complex many-to-many (online/offline) data replication/backup solution employing portable media as additional data storage and a means of data propagation between the offsites.
 
-Bitferry is a frontend to the [Rclone](https://rclone.org) and [Restic](https://restic.net) utilities.
+The core idea that drives Bitferry is the conversion of full (absolute) endpoint's paths into the volume-relative ones, where the volume is a data file which is put along the endpoint's data and denotes the root of the directory hierarchy. This leads to the important location independence property meaning that Bitferry is then able to restore the tasks' source-destination endpoint connections in spite of the volume location changes, which is a likely scenario in case of portable storage (different UNIX mount points, Windows drives etc.).
 
+Bitferry is effectively a frontend to the [Rclone](https://rclone.org) and [Restic](https://restic.net) utilities.
 
 ## Features
 
@@ -27,7 +28,6 @@ Bitferry is a frontend to the [Rclone](https://rclone.org) and [Restic](https://
 
 * Offline portable storage (USB flash, HDDs, SSDs etc.) relay
 
-
 ## Use cases
 
 * Maintain an update-only files copy in a separate location on the same site
@@ -36,7 +36,6 @@ Bitferry is a frontend to the [Rclone](https://rclone.org) and [Restic](https://
 
 * Maintain an incremental files backup on a portable medium with multiple offsite copies of the repository
 
-
 ## Implementation
 
 The Bitferry itself is written in [Ruby](https://www.ruby-lang.org) programming language. Being a Ruby code, the Bitferry requires the platform-specific Ruby runtime, version 3.0 or higher. 
@@ -45,28 +44,27 @@ The source code is hosted on [GitHub](https://github.com/okhlybov/bitferry) and
 
 In addition, the platform-specific [Rclone](https://github.com/rclone/rclone/releases) and [Restic](https://github.com/restic/restic/releases) executables are required to be accessible through the `PATH` directory list or through the respective `RCLONE` and `RESTIC` environment variables.
 
-
 ## Kickstart
 
-Install Bitferry
+### Install Bitferry
 
 ```shell
 gem install bitferry
 ```
 
-Prepare source Bitferry volume for a mounted local filesystem
+### Prepare source Bitferry volume for a mounted local filesystem
 
 ```shell
 bitferry create volume /data
 ```
 
-Prepare destination Bitferry volume for a mounted portable storage
+### Prepare destination Bitferry volume for a mounted portable storage
 
 ```shell
 bitferry create volume /mnt/usb-drive
 ```
 
-Ensure the volumes are intact
+### Ensure the volumes are intact
 
 ```shell
 bitferry show
@@ -79,13 +77,13 @@ bitferry show
   e42f2d8c    /mnt/usb-drive
 ```
 
-Create a (Rclone) sync task with data encryption
+### Create a (Rclone) sync task with data encryption
 
 ```shell
 bitferry create task sync -e /data /mnt/usb-drive/backup
 ```
 
-Review the changes
+### Review the changes
 
 ```shell
 bitferry
@@ -103,7 +101,7 @@ bitferry
   89e1c119    encrypt+synchronize :d2f10024: --> :e42f2d8c:backup
 ```
 
-Perform a dry run of the specific task
+### Perform a dry run of the specific task
 
 ```shell
 bitferry process -vn 89e
@@ -128,7 +126,7 @@ Elapsed time:         0.0s
 
 </details>
 
-Process all intact tasks in sequence
+### Process all intact tasks in sequence
 
 ```shell
 bitferry -v x
@@ -153,7 +151,7 @@ Elapsed time:         0.0s
 
 </details>
 
-Observe the result
+### Observe the result
 
 ```shell
 ls -l /mnt/usb-drive/backup
@@ -170,7 +168,7 @@ ls -l /mnt/usb-drive/backup
 
 </details>
 
-Examine the detailed usage instructions
+### Examine the detailed usage instructions
 
 ```shell
 bitferry c t s -h

data/lib/bitferry/cli.rb

@@ -165,14 +165,14 @@ Clamp do
       subcommand ['copy', 'c'], 'Create copy task' do
         banner %{
           Create source --> destination file copy task.
-      
+
           The task operates recursively on two specified endpoints.
           This task unconditionally copies all source files overwriting existing files in destination.
-      
+
           #{Endpoint}
-      
+
           #{Encryption}
-          
+
           This task employs the Rclone worker.
         }
         setup_rclone_task(self)
@@ -185,12 +185,12 @@ Clamp do
       subcommand ['update', 'u'], 'Create update task' do
         banner %{
           Create source --> destination file update (freshen) task.
-      
+
           The task operates recursively on two specified endpoints.
           This task copies newer source files while skipping unchanged files in destination.
-      
+
           #{Endpoint}
-      
+
           #{Encryption}
 
           This task employs the Rclone worker.
@@ -205,15 +205,15 @@ Clamp do
       subcommand ['synchronize', 'sync', 's'], 'Create one way sync task' do
         banner %{
           Create source --> destination one way file synchronization task.
-      
+
           The task operates recursively on two specified endpoints.
           This task copies newer source files while skipping unchanged files in destination.
           Also, it deletes destination files which are non-existent in source.
-      
+
           #{Endpoint}
 
           #{Encryption}
-      
+
           This task employs the Rclone worker.
         }
         setup_rclone_task(self)
@@ -226,15 +226,15 @@ Clamp do
       subcommand ['equalize', 'bisync', 'e'], 'Create two way sync task' do
         banner %{
           Create source <-> destination two way file synchronization task.
-      
+
           The task operates recursively on two specified endpoints.
           This task retains only the most recent versions of files on both endpoints.
           Opon execution both endpoints are left identical.
-      
+
           #{Endpoint}
 
           #{Encryption}
-      
+
           This task employs the Rclone worker.
         }
         setup_rclone_task(self)
@@ -341,4 +341,4 @@ Clamp do
   end
 
 
-end
+end