From a522cabfbd1bb3527f3409d367d492e647a4626d Mon Sep 17 00:00:00 2001 From: Brandon Iglesias Date: Fri, 17 Aug 2018 15:05:03 -0400 Subject: [PATCH] readme updates (Storj CLI) (#243) * updates to the readme Added section for the Storj CLI Styled AWS S3 CLI section * Update README.md * removed file name in upload object commands * updated title * added table of contents --- README.md | 84 +++++++++++++++++++++++++++---------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 6af05a8ed..5f09b0834 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Storj +# Storj V3 Netowrk [![Go Report Card](https://goreportcard.com/badge/github.com/storj/storj)](https://goreportcard.com/report/github.com/storj/storj) [![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/storj/storj) @@ -12,21 +12,46 @@ Storj is in the midst of a rearchitecture. Please stay tuned for our v3 whitepap Storj is a platform, token, and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, shredded into little pieces and stored in a global decentralized network of computers. Luckily, we also support allowing you (and only you) to recover them! +## Table of Contents + +- [Storj CLI](#storjcli) +- [AWS S3 CLI](#awss3cli) +- [Run Storj Locally](#storjlocal) +- [Support](#support) + + # Start Using Storj -### Download the latest release + +#### Download the latest release Go here to download the latest build // TODO: add link when a build is released // TODO for how to run the release -### Configure AWS CLI +## Using Storj via the Storj CLI -In a new terminal session: +#### Configure the Storj CLI +1) In a new terminal setup the Storj CLI: ```$ storj setup``` +2) Edit the API Key, overlay address, and pointer db address fields in the Storj CLI config file located at ```~/.storj/cli/config.yaml``` with values from the captplanet config file located at ```~/.storj/capt/config.yaml``` -Download and install the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/installing.html +#### Test out some Storj CLI commands! -Configure the AWS CLI: +1) Create a bucket: ```$ storj mb s3://bucket-name``` +2) Upload an object: ```$ storj cp ~/Desktop/your-large-file.mp4 s3://bucket-name``` +3) List objects in a bucket: ```$ storj ls s3://bucket-name/ ``` +4) Download an object: ```$ storj cp s3://bucket-name/your-large-file.mp4 ~/Desktop/your-large-file.mp4``` +6) Delete an object: ```$ storj rm s3://bucket-name/your-large-file.mp4``` + +--- + +## Using Storj via the AWS S3 CLI + +#### Configure AWS CLI + +Download and install the AWS S3 CLI: https://docs.aws.amazon.com/cli/latest/userguide/installing.html + +In a new terminal session configure the AWS S3 CLI: ```bash $ aws configure AWS Access Key ID [None]: insecure-dev-access-key @@ -35,43 +60,20 @@ Default region name [None]: us-east-1 Default output format [None]: $ aws configure set default.s3.multipart_threshold 1TB # until we support multipart ``` -Test some commands: -### Upload an Object +#### Test out some AWS S3 CLI commands! -```bash -$ aws s3 --endpoint=http://localhost:7777/ cp ~/Desktop/your-large-file.mp4 s3://bucket/your-large-file.mp4 -``` - -### Download an Object - -```bash -$ aws s3 --endpoint=http://localhost:7777/ cp s3://bucket/your-large-file.mp4 ~/Desktop/your-large-file.mp4 -``` - -### List Objects - -```bash -aws s3 --endpoint=http://localhost:7777/ ls s3://bucket/ --recursive -``` - - -### Delete Objects in a Bucket - -```bash -aws s3 --endpoint=http://localhost:7777/ rm --recursive s3://bucket/ -``` - -### Generate a URL for an Object - -```bash -aws s3 --endpoint=http://localhost:7777/ presign s3://bucket/your-large-file.mp4 -``` +1) Create a bucket: ```$ aws s3 --endpoint=http://localhost:7777/ mb s3://bucket-name``` +2) Upload an object: ```$ aws s3 --endpoint=http://localhost:7777/ cp ~/Desktop/your-large-file.mp4 s3://bucket-name``` +3) List objects in a bucket: ```$ aws s3 --endpoint=http://localhost:7777/ ls s3://bucket-name/ ``` +4) Download an object: ```$ aws s3 --endpoint=http://localhost:7777/ cp s3://bucket-name/your-large-file.mp4 ~/Desktop/your-large-file.mp4``` +5) Generate a URL for an object: ``` $ aws s3 --endpoint=http://localhost:7777/ presign s3://bucket-name/your-large-file.mp4``` +6) Delete an object: ```$ aws s3 --endpoint=http://localhost:7777/ rm s3://bucket-name/your-large-file.mp4``` For more information about the AWS s3 CLI visit: https://docs.aws.amazon.com/cli/latest/reference/s3/index.html -# Start Contributing to Storj +# Start Contributing to Storj ### Install required packages @@ -81,7 +83,7 @@ First, install git and golang. We currently support Debian-based and Mac operati Download and install the latest release of go https://golang.org/ -```bash +``` apt-get install git golang echo 'export STORJDEV="$HOME/storj"' >> $HOME/.bashrc echo 'export GOPATH="$STORJDEV:$STORJDEV/vendor"' >> $HOME/.bashrc @@ -116,7 +118,7 @@ mkdir -p $STORJDEV/src/storj.io git clone https://github.com/storj/storj $STORJDEV/src/storj.io/storj ``` -#### Install all dependencies +### Install all dependencies ```bash git clone --recursive https://github.com/storj/storj-vendor $STORJDEV/vendor @@ -142,8 +144,6 @@ go test storj.io/storj/... You can execute only a single test package. For example: `go test storj.io/storj/pkg/kademlia`. Add -v for more informations about the executed unit tests. -## Support +## Support If you have any questions or suggestions please reach out to us on [Rocketchat](https://community.storj.io/) or [Twitter](https://twitter.com/storjproject). - -