Skip to content

Home

Jump to bottom
Sid edited this page Sep 23, 2020 · 3 revisions

Flow Diagram

Config Files

There are two config files that contain Storj network and MaraiDB connection information. The tool is designed so you can specify a config file as part of your tooling/workflow.

db_property.json

Inside the ./config directory there is a db_property.json file, with following information about your mongoDB instance:

  • hostName- Host Name connect to mongoDB
  • port - Port connect to mongoDB
  • username - User Name of mongoDB
  • password - Password of mongoDB
  • database - mongoDB Database Name
storj_config.json

Inside the ./config directory a storj_config.json file, with Storj network configuration information in JSON format:

  • apiKey - API Key created in Storj Satellite GUI (mandatory)
  • satellite - Storj Satellite URL (mandatory)
  • encryptionPassphrase - Storj Encryption Passphrase (mandatory)
  • bucket - Name of the bucket to upload data into (mandatory)
  • uploadPath - Path on Storj Bucket to store data (optional) or "/" (mandatory)
  • serializedAccess - Serialized access shared while uploading data used to access bucket without API Key (mandatory)
  • allowDownload - Set true to create serialized access with restricted download (mandatory while using share flag)
  • allowUpload - Set true to create serialized access with restricted upload (mandatory while using share flag)
  • allowList - Set true to create serialized access with restricted list access
  • allowDelete - Set true to create serialized access with restricted delete
  • notBefore - Set time that is always before notAfter
  • notAfter - Set time that is always after notBefore

Run

Once you have built the project run the following commands as per your requirement:

Get help
$ ./connector-mongodb --help
Check version
$ ./connector-mongodb --version
Create back-up from mongoDB and upload them to Storj
$ ./connector-mongodb store --mongo <path_to_mongo_config_file> --storj <path_to_storj_config_file>
Create back-up from mongoDB and upload it to Storj bucket using Access Key
$ ./connector-mongodb store --accesskey
Create back-up from mongoDB and upload it to Storj and generate a Shareable Access Key based on restrictions in storj_config.json 
$ ./connector-mongodb store --share

Testing

The project has been tested on the following operating systems:

	* Windows
		* Version: 10 Pro
		* Processor: Intel(R) Core(TM) i3-5005U CPU @ 2.00GHz 2.00GHz
                * MongoDB version: 4.4

	* macOS Catalina
		* Version: 10.15.4
		* Processor: 2.5 GHz Dual-Core Intel Core i5
                * MongoDB version: 4.4

	* ubuntu
		* Version: 16.04 LTS
		* Processor: AMD A6-7310 APU with AMD Radeon R4 Graphics × 4
                * MongoDB version: 4.4
Clone this wiki locally