|
1 | | -# connector-zenko (uplink v1.0.5) |
2 | | - |
3 | | -[](https://app.codacy.com/gh/storj-thirdparty/connector-zenko?utm_source=github.com&utm_medium=referral&utm_content=storj-thirdparty/connector-zenko&utm_campaign=Badge_Grade_Dashboard) |
4 | | -[](https://goreportcard.com/report/github.com/storj-thirdparty/connector-zenko) |
5 | | - |
6 | | - |
7 | | -## Overview |
8 | | - |
9 | | -Command line application (on Windows/Linux/Mac) for taking data backup from Zenko to Storj. Application connects to Zenko server and the souce code for interaction to Storj for cloud storage which is written in Golang. |
10 | | - |
11 | | -Zenko is infrastructure software to control Data in Multi-Cloud IT Environments without cloud lock-in and has features such as enabling unified data management from anywhere through a secure cloud portal, providing a single S3 endpoint through which data can be stored, retrieved and searched across any location. |
12 | | - |
13 | | -### Features of connector-zenko: |
14 | | - |
15 | | -* Connects S3 compatible cloud storages (e.g. Amazon AWS, Azure Blob, Google Cloud Storage, Wasabi) to the Zenko instance for backing up their data to StorJ V3 network. |
16 | | -* Upload any type of data from Zenko to Storj (single or multiple at once) whether it is a folder, document, data file, image, video, etc. |
17 | | -``` |
18 | | -Usage: |
19 | | - connector-zenko [command] <flags> |
20 | | -
|
21 | | -Available Commands: |
22 | | - help Help about any command |
23 | | - store Command to upload data to a Storj V3 network. |
24 | | - version Prints the version of the tool |
25 | | -``` |
26 | | - |
27 | | -```store``` - Connect to the specified Zenko instance (default: ```zenko_property.json```). Backups of the Zenko storage are generated using tooling provided by Zenko then uploaded to the Storj network. Connect to a Storj v3 network using the access specified in the Storj configuration file (default: ```storj_config.json```). |
28 | | - |
29 | | -Sample configuration files are provided in the ```./config``` folder. |
30 | | - |
31 | | -## Requirements and Install |
32 | | - |
33 | | -To build from scratch, [install the latest Go](https://golang.org/doc/install#install). |
34 | | - |
35 | | -> Note: Ensure go modules are enabled (GO111MODULE=on) |
36 | | -
|
37 | | -#### Option #1: clone this repo (most common) |
38 | | - |
39 | | -To clone the repo |
40 | | - |
41 | | -``` |
42 | | -git clone https://github.com/storj-thirdparty/connector-zenko.git |
43 | | -``` |
44 | | - |
45 | | -Then, build the project using the following: |
46 | | - |
47 | | -``` |
48 | | -cd connector-zenko |
49 | | -go build |
50 | | -``` |
51 | | - |
52 | | -#### Option #2: go get into your gopath |
53 | | - |
54 | | -To download the project inside your GOPATH use the following command: |
55 | | - |
56 | | -``` |
57 | | -go get github.com/storj-thirdparty/connector-zenko |
58 | | -``` |
59 | | - |
60 | | -## Run (short version) |
61 | | - |
62 | | -Once you have built the project run the following commands as per your requirement: |
63 | | - |
64 | | -##### Get help |
65 | | - |
66 | | -``` |
67 | | -$ ./connector-zenko --help |
68 | | -``` |
69 | | - |
70 | | -##### Check version |
71 | | - |
72 | | -``` |
73 | | -$ ./connector-zenko --version |
74 | | -``` |
75 | | - |
76 | | -##### Create backup from Zenko and upload to Storj |
77 | | - |
78 | | -``` |
79 | | -$ ./connector-zenko store |
80 | | -``` |
81 | | - |
82 | | -## Documentation |
83 | | - |
84 | | -For more information on runtime flags, configuration, testing, and diagrams, check out the [Detail](//github.com/storj-thirdparty/connector-zenko/wiki) or jump to: |
85 | | - |
86 | | -* [Config Files](//github.com/storj-thirdparty/connector-zenko/wiki/#config-files) |
87 | | -* [Run (long version)](//github.com/storj-thirdparty/connector-zenko/wiki/#run) |
88 | | -* [Testing](//github.com/storj-thirdparty/connector-zenko/wiki/#testing) |
89 | | -* [Flow Diagram](//github.com/storj-thirdparty/connector-zenko/wiki/#flow-diagram) |
| 1 | +# connector-zenko (uplink v1.0.5) |
| 2 | + |
| 3 | +[](https://app.codacy.com/gh/storj-thirdparty/connector-zenko?utm_source=github.com&utm_medium=referral&utm_content=storj-thirdparty/connector-zenko&utm_campaign=Badge_Grade_Dashboard) |
| 4 | +[](https://goreportcard.com/report/github.com/storj-thirdparty/connector-zenko) |
| 5 | + |
| 6 | + |
| 7 | +## Overview |
| 8 | + |
| 9 | +Command line application (on Windows/Linux/Mac) for taking data backup from Zenko to Storj. Application connects to Zenko server and the souce code for interaction to Storj for cloud storage which is written in Golang. |
| 10 | + |
| 11 | +Zenko is infrastructure software to control Data in Multi-Cloud IT Environments without cloud lock-in and has features such as enabling unified data management from anywhere through a secure cloud portal, providing a single S3 endpoint through which data can be stored, retrieved and searched across any location. |
| 12 | + |
| 13 | +### Features of connector-zenko: |
| 14 | + |
| 15 | +* Connects S3 compatible cloud storages (e.g. Amazon AWS, Azure Blob, Google Cloud Storage, Wasabi) to the Zenko instance for backing up their data to StorJ V3 network. |
| 16 | +* Upload any type of data from Zenko to Storj (single or multiple at once) whether it is a folder, document, data file, image, video, etc. |
| 17 | +``` |
| 18 | +Usage: |
| 19 | + connector-zenko [command] <flags> |
| 20 | +
|
| 21 | +Available Commands: |
| 22 | + help Help about any command |
| 23 | + store Command to upload data to a Storj V3 network. |
| 24 | + version Prints the version of the tool |
| 25 | +``` |
| 26 | + |
| 27 | +```store``` - Connect to the specified Zenko instance (default: ```zenko_property.json```). Backups of the Zenko storage are generated using tooling provided by Zenko then uploaded to the Storj network. Connect to a Storj v3 network using the access specified in the Storj configuration file (default: ```storj_config.json```). |
| 28 | + |
| 29 | +Sample configuration files are provided in the ```./config``` folder. |
| 30 | + |
| 31 | +## Requirements and Install |
| 32 | + |
| 33 | +To build from scratch, [install the latest Go](https://golang.org/doc/install#install). |
| 34 | + |
| 35 | +> Note: Ensure go modules are enabled (GO111MODULE=on) |
| 36 | +
|
| 37 | +#### Option #1: clone this repo (most common) |
| 38 | + |
| 39 | +To clone the repo |
| 40 | + |
| 41 | +``` |
| 42 | +git clone https://github.com/storj-thirdparty/connector-zenko.git |
| 43 | +``` |
| 44 | + |
| 45 | +Then, build the project using the following: |
| 46 | + |
| 47 | +``` |
| 48 | +cd connector-zenko |
| 49 | +go build |
| 50 | +``` |
| 51 | + |
| 52 | +#### Option #2: go get into your gopath |
| 53 | + |
| 54 | +To download the project inside your GOPATH use the following command: |
| 55 | + |
| 56 | +``` |
| 57 | +go get github.com/storj-thirdparty/connector-zenko |
| 58 | +``` |
| 59 | + |
| 60 | +## Run (short version) |
| 61 | + |
| 62 | +Once you have built the project run the following commands as per your requirement: |
| 63 | + |
| 64 | +##### Get help |
| 65 | + |
| 66 | +``` |
| 67 | +$ ./connector-zenko --help |
| 68 | +``` |
| 69 | + |
| 70 | +##### Check version |
| 71 | + |
| 72 | +``` |
| 73 | +$ ./connector-zenko --version |
| 74 | +``` |
| 75 | + |
| 76 | +##### Create backup from Zenko and upload to Storj |
| 77 | + |
| 78 | +``` |
| 79 | +$ ./connector-zenko store |
| 80 | +``` |
| 81 | + |
| 82 | +## Documentation |
| 83 | + |
| 84 | +* Access documentation on local system : |
| 85 | + 1) Install [docsify](https://www.npmjs.com/package/docsify-cli) |
| 86 | + 2) Run the following command at the root directory of the cloned project. |
| 87 | + ``` |
| 88 | + $ docsify serve docs |
| 89 | + ``` |
| 90 | +* For more information on runtime flags, configuration, testing, and diagrams, check out the [Detail](//github.com/storj-thirdparty/connector-zenko/wiki) or jump to: |
| 91 | + * [Config Files](//github.com/storj-thirdparty/connector-zenko/wiki/#config-files) |
| 92 | + * [Run (long version)](//github.com/storj-thirdparty/connector-zenko/wiki/#run) |
| 93 | + * [Testing](//github.com/storj-thirdparty/connector-zenko/wiki/#testing) |
| 94 | + * [Flow Diagram](//github.com/storj-thirdparty/connector-zenko/wiki/#flow-diagram) |
| 95 | + * [Video](//github.com/storj-thirdparty/connector-zenko/#/videos) |
0 commit comments