From 6a8ccc5925d6e996beab18d8dd44f134f5616549 Mon Sep 17 00:00:00 2001 From: poornas Date: Thu, 29 Nov 2018 15:50:57 -0800 Subject: [PATCH] update README.md (#6893) --- docs/bucket/notifications/README.md | 42 +++++++++++------------ docs/multi-user/README.md | 16 ++++----- docs/zh_CN/bucket/notifications/README.md | 38 ++++++++++---------- 3 files changed, 48 insertions(+), 48 deletions(-) diff --git a/docs/bucket/notifications/README.md b/docs/bucket/notifications/README.md index e975b1485..9de5c2287 100644 --- a/docs/bucket/notifications/README.md +++ b/docs/bucket/notifications/README.md @@ -87,8 +87,8 @@ We will enable bucket event notification to trigger whenever a JPEG image is upl ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:amqp --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:amqp --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:amqp s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -199,8 +199,8 @@ We will enable bucket event notification to trigger whenever a JPEG image is upl ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:mqtt --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:mqtt --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:amqp s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -314,8 +314,8 @@ With the `mc` tool, the configuration is very simple to add. Let us say that the ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:elasticsearch --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:elasticsearch --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:elasticsearch s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -460,8 +460,8 @@ With the `mc` tool, the configuration is very simple to add. Let us say that the ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:redis --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:redis --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:redis s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -563,8 +563,8 @@ We will enable bucket event notification to trigger whenever a JPEG image is upl ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:nats --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:nats --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:nats s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -745,10 +745,10 @@ With the `mc` tool, the configuration is very simple to add. Let us say that the # Create bucket named `images` in myminio mc mb myminio/images # Add notification configuration on the `images` bucket using the MySQL ARN. The --suffix argument filters events. -mc events add myminio/images arn:minio:sqs::1:postgresql --suffix .jpg +mc event add myminio/images arn:minio:sqs::1:postgresql --suffix .jpg # Print out the notification configuration on the `images` bucket. -mc events list myminio/images -mc events list myminio/images +mc event list myminio/images +mc event list myminio/images arn:minio:sqs::1:postgresql s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -844,9 +844,9 @@ With the `mc` tool, the configuration is very simple to add. Let us say that the # Create bucket named `images` in myminio mc mb myminio/images # Add notification configuration on the `images` bucket using the MySQL ARN. The --suffix argument filters events. -mc events add myminio/images arn:minio:sqs::1:postgresql --suffix .jpg +mc event add myminio/images arn:minio:sqs::1:postgresql --suffix .jpg # Print out the notification configuration on the `images` bucket. -mc events list myminio/images +mc event list myminio/images arn:minio:sqs::1:postgresql s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -908,8 +908,8 @@ We will enable bucket event notification to trigger whenever a JPEG image is upl ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:kafka --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:kafka --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:kafka s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -965,13 +965,13 @@ We will enable bucket event notification to trigger whenever a JPEG image is upl ``` mc mb myminio/images mc mb myminio/images-thumbnail -mc events add myminio/images arn:minio:sqs::1:webhook --events put --suffix .jpg +mc event add myminio/images arn:minio:sqs::1:webhook --events put --suffix .jpg ``` Check if event notification is successfully configured by ``` -mc events list myminio/images +mc event list myminio/images ``` You should get a response like this @@ -1055,8 +1055,8 @@ We will enable bucket event notification to trigger whenever a JPEG image is upl ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs::1:nsq --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs::1:nsq --suffix .jpg +mc event list myminio/images arn:minio:sqs::1:nsq s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` diff --git a/docs/multi-user/README.md b/docs/multi-user/README.md index 39c27c77b..ea122054a 100644 --- a/docs/multi-user/README.md +++ b/docs/multi-user/README.md @@ -10,7 +10,7 @@ In this document we will explain in detail on how to configure multiple users. - Install Minio - [Minio Quickstart Guide](https://docs.minio.io/docs/minio-quickstart-guide) ### 2. Create a new user with canned policy -Use [`mc admin policies`](https://docs.minio.io/docs/minio-admin-complete-guide.html#policies) to create canned policies. Server provides a default set of canned policies namely `writeonly`, `readonly` and `readwrite` *(these policies apply to all resources on the server)*. These can be overridden by custom policies using `mc admin policies` command. +Use [`mc admin policy`](https://docs.minio.io/docs/minio-admin-complete-guide.html#policies) to create canned policies. Server provides a default set of canned policies namely `writeonly`, `readonly` and `readwrite` *(these policies apply to all resources on the server)*. These can be overridden by custom policies using `mc admin policy` command. Create new canned policy file `getonly.json`. This policy enables users to download all objects under `my-bucketname`. ```json @@ -35,36 +35,36 @@ EOF Create new canned policy by name `getonly` using `getonly.json` policy file. ``` -mc admin policies add myminio getonly getonly.json +mc admin policy add myminio getonly getonly.json ``` -Create a new user `newuser` on Minio use `mc admin users`, specify `getonly` canned policy for this `newuser`. +Create a new user `newuser` on Minio use `mc admin user`, specify `getonly` canned policy for this `newuser`. ``` -mc admin users add myminio newuser newuser123 getonly +mc admin user add myminio newuser newuser123 getonly ``` ### 3. Disable user Disable user `newuser`. ``` -mc admin users disable myminio newuser +mc admin user disable myminio newuser ``` ### 4. Remove user Remove the user `newuser`. ``` -mc admin users remove myminio newuser +mc admin user remove myminio newuser ``` ### 5. Change user policy Change the policy for user `newuser` to `putonly` canned policy. ``` -mc admin users policy myminio newuser putonly +mc admin user policy myminio newuser putonly ``` ### 5. List all users List all enabled and disabled users. ``` -mc admin users list myminio +mc admin user list myminio ``` ### 6. Configure `mc` diff --git a/docs/zh_CN/bucket/notifications/README.md b/docs/zh_CN/bucket/notifications/README.md index fe06454f1..783c4f18d 100644 --- a/docs/zh_CN/bucket/notifications/README.md +++ b/docs/zh_CN/bucket/notifications/README.md @@ -77,8 +77,8 @@ Minio支持[RabbitMQ](https://www.rabbitmq.com/)中所有的交换方式，这 ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs:us-east-1:1:amqp --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs:us-east-1:1:amqp --suffix .jpg +mc event list myminio/images arn:minio:sqs:us-east-1:1:amqp s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -183,8 +183,8 @@ Minio支持任何支持MQTT 3.1或3.1.1的MQTT服务器，并且可以通过TCP ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs:us-east-1:1:mqtt --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs:us-east-1:1:mqtt --suffix .jpg +mc event list myminio/images arn:minio:sqs:us-east-1:1:amqp s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -297,8 +297,8 @@ Minio Server的配置文件默认路径是 ``~/.minio/config.json``。ES配置 ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs:us-east-1:1:elasticsearch --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs:us-east-1:1:elasticsearch --suffix .jpg +mc event list myminio/images arn:minio:sqs:us-east-1:1:elasticsearch s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -436,8 +436,8 @@ Minio Server的配置文件默认路径是 ``~/.minio/config.json``。Redis配 ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs:us-east-1:1:redis --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs:us-east-1:1:redis --suffix .jpg +mc event list myminio/images arn:minio:sqs:us-east-1:1:redis s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -534,8 +534,8 @@ Minio服务也支持 [NATS Streaming mode](http://nats.io/documentation/streamin ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs:us-east-1:1:nats --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs:us-east-1:1:nats --suffix .jpg +mc event list myminio/images arn:minio:sqs:us-east-1:1:nats s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -711,10 +711,10 @@ Minio Server的配置文件默认路径是 ``~/.minio/config.json``。PostgreSQL # Create bucket named `images` in myminio mc mb myminio/images # Add notification configuration on the `images` bucket using the MySQL ARN. The --suffix argument filters events. -mc events add myminio/images arn:minio:sqs:us-east-1:1:postgresql --suffix .jpg +mc event add myminio/images arn:minio:sqs:us-east-1:1:postgresql --suffix .jpg # Print out the notification configuration on the `images` bucket. -mc events list myminio/images -mc events list myminio/images +mc event list myminio/images +mc event list myminio/images arn:minio:sqs:us-east-1:1:postgresql s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -805,9 +805,9 @@ Minio Server的配置文件默认路径是 ``~/.minio/config.json``。MySQL配 # Create bucket named `images` in myminio mc mb myminio/images # Add notification configuration on the `images` bucket using the MySQL ARN. The --suffix argument filters events. -mc events add myminio/images arn:minio:sqs:us-east-1:1:postgresql --suffix .jpg +mc event add myminio/images arn:minio:sqs:us-east-1:1:postgresql --suffix .jpg # Print out the notification configuration on the `images` bucket. -mc events list myminio/images +mc event list myminio/images arn:minio:sqs:us-east-1:1:postgresql s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -865,8 +865,8 @@ Minio Server的配置文件默认路径是 ``~/.minio/config.json``。参考下 ``` mc mb myminio/images -mc events add myminio/images arn:minio:sqs:us-east-1:1:kafka --suffix .jpg -mc events list myminio/images +mc event add myminio/images arn:minio:sqs:us-east-1:1:kafka --suffix .jpg +mc event list myminio/images arn:minio:sqs:us-east-1:1:kafka s3:ObjectCreated:*,s3:ObjectRemoved:* Filter: suffix=”.jpg” ``` @@ -916,13 +916,13 @@ endpoint是监听webhook通知的服务。保存配置文件并重启Minio服务 ``` mc mb myminio/images mc mb myminio/images-thumbnail -mc events add myminio/images arn:minio:sqs:us-east-1:1:webhook --events put --suffix .jpg +mc event add myminio/images arn:minio:sqs:us-east-1:1:webhook --events put --suffix .jpg ``` 验证事件通知是否配置正确： ``` -mc events list myminio/images +mc event list myminio/images ``` 你应该可以收到如下的响应：