From 16d2c44fd6ef103ff586e8b76a4dd4bd15d53e3b Mon Sep 17 00:00:00 2001 From: koolhead17 Date: Tue, 26 Jul 2016 11:43:34 -0700 Subject: [PATCH] Doc: Modified S3cmd,Rclone naming convention with camelcase and updated (#52) splash screen for Minio server. --- README.md | 4 +-- docs/rclone-with-minio.md | 44 +++++++++++++++++++-------------- docs/running-minio-in-docker.md | 43 +++++++++++++++++++++++++------- docs/s3cmd-with-minio.md | 10 ++++---- 4 files changed, 67 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 9e3bae2..f11024d 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,9 @@ Note: You can also refer to [Awesome Minio](https://github.com/minio/awesome-min - [Store MySQL Backups in Minio](./docs/store-mysql-backups-in-minio.md) - [Store PostgreSQL Backups in Minio](./docs/store-postgresql-backups-in-minio.md) - [restic with Minio](./docs/restic-with-minio.md) -- [s3cmd with Minio](./docs/s3cmd-with-minio.md) +- [S3cmd with Minio](./docs/s3cmd-with-minio.md) - [Aggregate Apache logs with fluentd and Minio](./docs/aggregate-apache-logs-with-fluentd-and-minio.md) - [Generate Let's Encypt certificate using Concert for Minio](./docs/generate-lets-encypt-certificate-using-concert-for-minio.md) - [Setup Caddy proxy with Minio](./docs/setup-caddy-proxy-with-minio.md) - [Setup Nginx proxy with Minio](./docs/setup-nginx-proxy-with-minio.md) -- [rclone with Minio](./docs/rclone-with-minio.md) +- [Rclone with Minio](./docs/rclone-with-minio.md) diff --git a/docs/rclone-with-minio.md b/docs/rclone-with-minio.md index f07b235..c76ca04 100644 --- a/docs/rclone-with-minio.md +++ b/docs/rclone-with-minio.md @@ -1,6 +1,6 @@ -# rclone with Minio Server [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/minio/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Rclone with Minio Server [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/minio/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -`rclone` is an open source command line program to sync files and +`Rclone` is an open source command line program to sync files and directories to and from cloud storage systems. It aims to be "rsync for cloud storage". @@ -12,7 +12,7 @@ First install Minio Server from [minio.io](https://minio.io/). ## 2. Installation -Next install rclone from [rclone.org](http://rclone.org). +Next install Rclone from [rclone.org](http://rclone.org). ## 3. Configuration @@ -20,21 +20,29 @@ When it configures itself Minio will print something like this ```sh -AccessKey: WLGDGYAQYIGI833EV05A SecretKey: BYvgJM101sHngl2uzjXS/OBF/aMxAN06JrJ3qJlF Region: us-east-1 +Endpoint: http://10.0.0.3:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 +AccessKey: USWUXHGYZQYFYFFIT3RE +SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +Region: us-east-1 -Minio Object Storage: - http://127.0.0.1:9000 - http://10.0.0.3:9000 +Browser Access: + http://10.0.0.3:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 + +Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide + $ mc config host add myminio http://10.0.0.3:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + +Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang-client-quickstart-guide + Java: https://docs.minio.io/docs/java-client-quickstart-guide + Python: https://docs.minio.io/docs/python-client-quickstart-guide + JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide -Minio Browser: - http://127.0.0.1:9000 - http://10.0.0.3:9000 ``` You now need to configure those details into rclone. -Run `rclone config`, create a new remote called `minio` (or anything +Run `Rclone config`, create a new remote called `minio` (or anything else) of type `S3` and enter the details above something like this: (Note that it is important to put the region in as stated above.) @@ -42,8 +50,8 @@ else) of type `S3` and enter the details above something like this: ```sh env_auth> 1 -access_key_id> WLGDGYAQYIGI833EV05A -secret_access_key> BYvgJM101sHngl2uzjXS/OBF/aMxAN06JrJ3qJlF +access_key_id> USWUXHGYZQYFYFFIT3RE +secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us-east-1 endpoint> http://10.0.0.3:9000 location_constraint> @@ -57,8 +65,8 @@ Which makes the config file look like this [minio] env_auth = false -access_key_id = WLGDGYAQYIGI833EV05A -secret_access_key = BYvgJM101sHngl2uzjXS/OBF/aMxAN06JrJ3qJlF +access_key_id = USWUXHGYZQYFYFFIT3RE +secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03F region = us-east-1 endpoint = http://10.0.0.3:9000 location_constraint = @@ -69,9 +77,9 @@ server_side_encryption = ## 4. Commands Minio doesn't support all the features of S3 yet. In particular it -doesn't support MD5 checksums (ETags) or metadata. This means rclone +doesn't support MD5 checksums (ETags) or metadata. This means Rclone can't check MD5SUMs or store the modified date. However you can work -around this with the `--size-only` flag of rclone. +around this with the `--size-only` flag of Rclone. Here are some example commands @@ -103,4 +111,4 @@ Then sync for real rclone --size-only sync /path/to/files minio:bucket -See the [rclone web site](http://rclone.org) for more examples and docs. +See the [Rclone web site](http://rclone.org) for more examples and docs. diff --git a/docs/running-minio-in-docker.md b/docs/running-minio-in-docker.md index 54a04ef..03fcac1 100644 --- a/docs/running-minio-in-docker.md +++ b/docs/running-minio-in-docker.md @@ -23,11 +23,24 @@ alias docker="sudo /usr/bin/docker" $ docker run -p 9000:9000 minio/minio:latest -AccessKey: IQP18YBF51DG8HSZEE7B SecretKey: AlDzw6dj9zfne8JhPwGapt0Idlfg/QLhMq58Z0ax +Endpoint: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 +AccessKey: USWUXHGYZQYFYFFIT3RE +SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +Region: us-east-1 + +Browser Access: + http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 + +Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide + $ mc config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + +Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang-client-quickstart-guide + Java: https://docs.minio.io/docs/java-client-quickstart-guide + Python: https://docs.minio.io/docs/python-client-quickstart-guide + JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide + -Starting minio server: -Listening on http://127.0.0.1:9000 -Listening on http://172.17.0.3:9000 ``` @@ -35,7 +48,7 @@ Listening on http://172.17.0.3:9000 ```sh -$ mc config host add localhost http://localhost:9000 IQP18YBF51DG8HSZEE7B AlDzw6dj9zfne8JhPwGapt0Idlfg/QLhMq58Z0ax +$ mc config host add localhost http://localhost:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 ``` @@ -45,6 +58,7 @@ $ mc config host add localhost http://localhost:9000 IQP18YBF51DG8HSZEE7B AlDzw6 $ mc mb localhost/newbucket Bucket created successfully ‘localhost/newbucket’. + $ mc mb localhost/mybucket Bucket created successfully ‘localhost/mybucket’. @@ -81,14 +95,25 @@ $ docker stop 51e3a48d209a $ docker create -v /export --name minio-export minio/my-minio /bin/true 4e466c4572b96cc16a619f6e13155657745aa653b1857929100f1a8208a58da8 + $ docker run -p 9000:9000 --volumes-from minio-export --name minio1 minio/my-minio -AccessKey: IQP18YBF51DG8HSZEE7B SecretKey: AlDzw6dj9zfne8JhPwGapt0Idlfg/QLhMq58Z0ax +Endpoint: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 +AccessKey: USWUXHGYZQYFYFFIT3RE +SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +Region: us-east-1 +Browser Access: + http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 -Starting minio server: -Listening on http://127.0.0.1:9000 -Listening on http://172.17.0.4:9000 +Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide + $ mc config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + +Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang-client-quickstart-guide + Java: https://docs.minio.io/docs/java-client-quickstart-guide + Python: https://docs.minio.io/docs/python-client-quickstart-guide + JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide ``` diff --git a/docs/s3cmd-with-minio.md b/docs/s3cmd-with-minio.md index 2759f2f..178e320 100644 --- a/docs/s3cmd-with-minio.md +++ b/docs/s3cmd-with-minio.md @@ -1,8 +1,8 @@ # S3cmd with Minio Server [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/minio/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -`s3cmd` is a CLI client for managing data in AWS S3, Google Cloud Storage or any cloud storage service provider that uses the s3 protocol. `s3cmd` is open source and is distributed under the GPLv2 license. +`S3cmd` is a CLI client for managing data in AWS S3, Google Cloud Storage or any cloud storage service provider that uses the s3 protocol. `S3cmd` is open source and is distributed under the GPLv2 license. -In this recipe we will learn how to configure and use s3cmd to manage data with Minio Server. +In this recipe we will learn how to configure and use S3cmd to manage data with Minio Server. ## 1. Prerequisites @@ -10,11 +10,11 @@ Install Minio Server from [here](http://docs.minio.io/docs/minio). ## 2. Installation -Install `s3cmd` from http://s3tools.org/s3cmd. +Install `S3cmd` from http://s3tools.org/s3cmd. ## 3. Configuration -We will run `s3cmd` on https://play.minio.io:9000. +We will run `S3cmd` on https://play.minio.io:9000. Access credentials shown in this example belong to https://play.minio.io:9000. These credentials are open to public. Feel free to use this service for testing and development. Replace with your own Minio keys in deployment. @@ -123,4 +123,4 @@ Bucket 's3://mybucket/' removed ``` NOTE: -The complete usage guide for `s3cmd` is available [here](http://s3tools.org/usage). +The complete usage guide for `S3cmd` is available [here](http://s3tools.org/usage).