Skip to content

Commit dbe456c

Browse files
docs: update some verbiage and wording (#564)
1 parent 6a96ec8 commit dbe456c

File tree

2 files changed

+37
-29
lines changed

2 files changed

+37
-29
lines changed

.goreleaser.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ changelog:
7272

7373
nfpms:
7474
-
75-
vendor: MinIO Inc.
75+
vendor: MinIO, Inc.
7676
homepage: https://github.com/minio/console
77-
maintainer: MinIO <minio@minio.io>
77+
maintainer: MinIO Development <dev@min.io>
7878
description: MinIO Console Server
7979
license: GNU Affero General Public License v3.0
8080
formats:

README.md

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22

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

5-
65
| Dashboard | Creating a bucket |
76
| ------------- | ------------- |
87
| ![Dashboard](images/pic1.png) | ![Dashboard](images/pic2.png) |
98

10-
## Setup
9+
### Setup
1110

1211
All `console` needs is a MinIO user with admin privileges and URL pointing to your MinIO deployment.
1312
> Note: We don't recommend using MinIO's Operator Credentials
1413
15-
1. Create a user for `console` using `mc`.
14+
#### 1. Create a user `console` using `mc`
15+
1616
```bash
17-
$ set +o history
18-
$ mc admin user add myminio console YOURCONSOLESECRET
19-
$ set -o history
17+
mc admin user add myminio/
18+
Enter Access Key: console
19+
Enter Secret Key: xxxxxxxx
2020
```
2121

22-
2. Create a policy for `console` with access to everything (for testing and debugging)
22+
#### 2. Create a policy for `console` with admin access to all resources (for testing)
2323

24-
```json
25-
$ cat > consoleAdmin.json << EOF
24+
```sh
25+
cat > admin.json << EOF
2626
{
2727
"Version": "2012-10-17",
2828
"Statement": [{
@@ -45,18 +45,20 @@ $ cat > consoleAdmin.json << EOF
4545
]
4646
}
4747
EOF
48-
$ mc admin policy add myminio consoleAdmin consoleAdmin.json
4948
```
5049

51-
3. Set the policy for the new `console` user
52-
50+
```sh
51+
mc admin policy add myminio/ consoleAdmin admin.json
5352
```
54-
$ mc admin policy set myminio consoleAdmin user=console
53+
54+
#### 3. Set the policy for the new `console` user
55+
56+
```sh
57+
mc admin policy set myminio consoleAdmin user=console
5558
```
5659

60+
> 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:
5761
58-
### Note
59-
Additionally, you can create policies to limit the privileges for `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:
6062
```json
6163
{
6264
"Version": "2012-10-17",
@@ -97,32 +99,41 @@ Additionally, you can create policies to limit the privileges for `console` user
9799
}
98100
```
99101

100-
## Run Console server
101-
To run the server:
102+
## Start Console service:
102103

103-
```bash
104+
Before running console service, following environment settings must be supplied
105+
```sh
104106
# Salt to encrypt JWT payload
105107
export CONSOLE_PBKDF_PASSPHRASE=SECRET
106108

107-
#required to encrypt jwet payload
109+
# Required to encrypt JWT payload
108110
export CONSOLE_PBKDF_SALT=SECRET
109111

110-
# MinIO endpoint
112+
# MinIO Endpoint
111113
export CONSOLE_MINIO_SERVER=http://localhost:9000
114+
```
115+
116+
Now start the console service.
117+
```
112118
./console server
119+
2021-01-19 02:36:08.893735 I | 2021/01/19 02:36:08 server.go:129: Serving console at http://localhost:9090
113120
```
114121

115-
## Run Console with TLS enable
122+
By default `console` runs on port `9090` this can be changed with `--port` of your choice.
123+
124+
## Start Console service with TLS:
116125

117126
Copy your `public.crt` and `private.key` to `~/.console/certs`, then:
118127

119-
```bash
128+
```sh
120129
./console server
130+
2021-01-19 02:36:08.893735 I | 2021/01/19 02:36:08 server.go:129: Serving console at https://localhost:9090
121131
```
122132

123-
Additionally, `Console` has support for multiple certificates, clients can request them using `SNI`. It expects the following structure:
133+
For advanced users, `console` has support for multiple certificates to service clients through multiple domains.
124134

125-
```bash
135+
Following tree structure is expected for supporting multiple domains:
136+
```sh
126137
certs/
127138
128139
├─ public.crt
@@ -140,9 +151,6 @@ Additionally, `Console` has support for multiple certificates, clients can reque
140151

141152
```
142153

143-
Therefore, we read all filenames in the cert directory and check
144-
for each directory whether it contains a public.crt and private.key.
145-
146154
## Connect Console to a Minio using TLS and a self-signed certificate
147155

148156
Copy the MinIO `ca.crt` under `~/.console/certs/CAs`, then:

0 commit comments

Comments
 (0)