Skip to content

Commit ecce093

Browse files
docs: add more color to the readme (#3549)
1 parent 5553e7e commit ecce093

File tree

1 file changed

+45
-44
lines changed

1 file changed

+45
-44
lines changed

README.md

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MinIO Console
22

3-
![build](https://github.com/minio/console/workflows/Go/badge.svg) ![license](https://img.shields.io/badge/license-AGPL%20V3-blue)
3+
![build](https://github.com/minio/object-browser/actions/workflows/jobs.yaml/badge.svg) ![license](https://img.shields.io/badge/license-AGPL%20V3-blue)
44

55
A graphical user interface for [MinIO](https://github.com/minio/minio)
66

@@ -32,7 +32,8 @@ MinIO Console is a library that provides a management and browser UI overlay for
3232

3333
All `console` needs is a MinIO user with admin privileges and URL pointing to your MinIO deployment.
3434

35-
> Note: We don't recommend using MinIO's Operator Credentials
35+
> [!NOTE]
36+
> We don't recommend using MinIO's Operator Credentials
3637
3738
### 1. Create a user `console` using `mc`
3839

@@ -80,50 +81,50 @@ mc admin policy create myminio/ consoleAdmin admin.json
8081
mc admin policy attach myminio consoleAdmin --user=console
8182
```
8283

83-
> NOTE: Additionally, you can create policies to limit the privileges for other `console` users, for example, if you
84+
> [!NOTE]
85+
> Additionally, you can create policies to limit the privileges for other `console` users, for example, if you
8486
> want the user to only have access to dashboard, buckets, notifications and watch page, the policy should look like
8587
> this:
86-
87-
```json
88-
{
89-
"Version": "2012-10-17",
90-
"Statement": [
91-
{
92-
"Action": [
93-
"admin:ServerInfo"
94-
],
95-
"Effect": "Allow",
96-
"Sid": ""
97-
},
98-
{
99-
"Action": [
100-
"s3:ListenBucketNotification",
101-
"s3:PutBucketNotification",
102-
"s3:GetBucketNotification",
103-
"s3:ListMultipartUploadParts",
104-
"s3:ListBucketMultipartUploads",
105-
"s3:ListBucket",
106-
"s3:HeadBucket",
107-
"s3:GetObject",
108-
"s3:GetBucketLocation",
109-
"s3:AbortMultipartUpload",
110-
"s3:CreateBucket",
111-
"s3:PutObject",
112-
"s3:DeleteObject",
113-
"s3:DeleteBucket",
114-
"s3:PutBucketPolicy",
115-
"s3:DeleteBucketPolicy",
116-
"s3:GetBucketPolicy"
117-
],
118-
"Effect": "Allow",
119-
"Resource": [
120-
"arn:aws:s3:::*"
121-
],
122-
"Sid": ""
123-
}
124-
]
125-
}
126-
```
88+
> ```json
89+
> {
90+
> "Version": "2012-10-17",
91+
> "Statement": [
92+
> {
93+
> "Action": [
94+
> "admin:ServerInfo"
95+
> ],
96+
> "Effect": "Allow",
97+
> "Sid": ""
98+
> },
99+
> {
100+
> "Action": [
101+
> "s3:ListenBucketNotification",
102+
> "s3:PutBucketNotification",
103+
> "s3:GetBucketNotification",
104+
> "s3:ListMultipartUploadParts",
105+
> "s3:ListBucketMultipartUploads",
106+
> "s3:ListBucket",
107+
> "s3:HeadBucket",
108+
> "s3:GetObject",
109+
> "s3:GetBucketLocation",
110+
> "s3:AbortMultipartUpload",
111+
> "s3:CreateBucket",
112+
> "s3:PutObject",
113+
> "s3:DeleteObject",
114+
> "s3:DeleteBucket",
115+
> "s3:PutBucketPolicy",
116+
> "s3:DeleteBucketPolicy",
117+
> "s3:GetBucketPolicy"
118+
> ],
119+
> "Effect": "Allow",
120+
> "Resource": [
121+
> "arn:aws:s3:::*"
122+
> ],
123+
> "Sid": ""
124+
> }
125+
> ]
126+
> }
127+
> ```
127128
128129
## Start Console service:
129130

0 commit comments

Comments
 (0)