Skip to content
This repository has been archived by the owner on Sep 6, 2019. It is now read-only.

Latest commit

 

History

History
48 lines (31 loc) · 2.53 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.53 KB
Raw

goobox-sync-storj

Build Status Storj.io

Sync app for Storj.

Prerequisites

  1. Install Java 8. Make sure to install the 64-bit variant.
  2. Install libstorj
  3. Import your keys using the libstorj CLI. Don't use a passcode. This is not supported yet by the sync app.

Installation

  1. Download the ZIP package of the latest release
  2. Extract the ZIP on the local file system

Usage

  1. Open a Command Prompt / Terminal
  2. Navigate to the extracted goobox-sync-storj folder
  3. Run the batch file, i.e. goobox-sync-storj.bat

The app uses the auth file in the <user.home>/.storj folder created by the libstorj CLI for the authentication with the Storj bridge.

Currently the app supports basic two-way sync between the Storj cloud to the local file system. The app will sync the content of the bucket with name Goobox to the local folder with name Goobox, which is a subfolder of the user home folder. If either the bucket or the local folder do not exist, the app will automatically create empty ones.

The app polls the Storj cloud and the local Goobox sync folder once per minute for any changes in the content. If file is created, deleted or modified in the local sync folder, the sync will be triggered within 5 seconds.

Basic sync scenarios should work: initial sync, downloading and uploading modified files. More care is required for more complex scenarios: conflicts, download/upload failures, etc.

The app uses an embedded Nitrine database for storing the current sync state of the files. The DB file can be found at the following location:

  • C:\Users\<user-name>\AppData\Local\Goobox for Windows
  • ~/.local/share/Goobox for Linux
  • ~/Library/Application Support/Goobox for macOS

The list-db.bat script can be used to dump the content of the database. This might be useful for debugging.

Overlay icons on Windows

Setting up the overlay icons on Windows required the following steps:

  1. Make sure the Microsoft Visual C++ 2010 Redistributable Package (x64) is installed on the system
  2. Open a Command Prompt as Administrator
  3. Execute the register-dlls.bat file
  4. Restart Windows
  5. Run the app as usual