Skip to content

docs: add more color to the readme #3549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2025
Merged

docs: add more color to the readme #3549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 45 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MinIO Console

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

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

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

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

> Note: We don't recommend using MinIO's Operator Credentials
> [!NOTE]
> We don't recommend using MinIO's Operator Credentials

### 1. Create a user `console` using `mc`

Expand Down Expand Up @@ -80,50 +81,50 @@ mc admin policy create myminio/ consoleAdmin admin.json
mc admin policy attach myminio consoleAdmin --user=console
```

> NOTE: Additionally, you can create policies to limit the privileges for other `console` users, for example, if you
> [!NOTE]
> Additionally, you can create policies to limit the privileges for other `console` users, for example, if you
> want the user to only have access to dashboard, buckets, notifications and watch page, the policy should look like
> this:

```json
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"admin:ServerInfo"
],
"Effect": "Allow",
"Sid": ""
},
{
"Action": [
"s3:ListenBucketNotification",
"s3:PutBucketNotification",
"s3:GetBucketNotification",
"s3:ListMultipartUploadParts",
"s3:ListBucketMultipartUploads",
"s3:ListBucket",
"s3:HeadBucket",
"s3:GetObject",
"s3:GetBucketLocation",
"s3:AbortMultipartUpload",
"s3:CreateBucket",
"s3:PutObject",
"s3:DeleteObject",
"s3:DeleteBucket",
"s3:PutBucketPolicy",
"s3:DeleteBucketPolicy",
"s3:GetBucketPolicy"
],
"Effect": "Allow",
"Resource": [
"arn:aws:s3:::*"
],
"Sid": ""
}
]
}
```
> ```json
> {
> "Version": "2012-10-17",
> "Statement": [
> {
> "Action": [
> "admin:ServerInfo"
> ],
> "Effect": "Allow",
> "Sid": ""
> },
> {
> "Action": [
> "s3:ListenBucketNotification",
> "s3:PutBucketNotification",
> "s3:GetBucketNotification",
> "s3:ListMultipartUploadParts",
> "s3:ListBucketMultipartUploads",
> "s3:ListBucket",
> "s3:HeadBucket",
> "s3:GetObject",
> "s3:GetBucketLocation",
> "s3:AbortMultipartUpload",
> "s3:CreateBucket",
> "s3:PutObject",
> "s3:DeleteObject",
> "s3:DeleteBucket",
> "s3:PutBucketPolicy",
> "s3:DeleteBucketPolicy",
> "s3:GetBucketPolicy"
> ],
> "Effect": "Allow",
> "Resource": [
> "arn:aws:s3:::*"
> ],
> "Sid": ""
> }
> ]
> }
> ```

## Start Console service:

Expand Down