Skip to content

Commit 3262212

Browse files
committed
update README.md to link the binaries
1 parent ee1a671 commit 3262212

File tree

3 files changed

+88
-13
lines changed

3 files changed

+88
-13
lines changed

README.md

+44-7
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,69 @@ A graphical user interface for [MinIO](https://github.com/minio/minio)
1212
**Table of Contents**
1313

1414
- [MinIO Console](#minio-console)
15-
- [-](#-)
15+
- [Install](#install)
16+
- [Binary Releases](#binary-releases)
17+
- [Docker](#docker)
18+
- [Build from source](#build-from-source)
19+
- [Setup](#setup)
1620
- [1. Create a user `console` using `mc`](#1-create-a-user-console-using-mc)
1721
- [2. Create a policy for `console` with admin access to all resources (for testing)](#2-create-a-policy-for-console-with-admin-access-to-all-resources-for-testing)
1822
- [3. Set the policy for the new `console` user](#3-set-the-policy-for-the-new-console-user)
1923
- [Start Console service:](#start-console-service)
20-
- [Salt to encrypt JWT payload](#salt-to-encrypt-jwt-payload)
2124
- [Start Console service with TLS:](#start-console-service-with-tls)
2225
- [Connect Console to a Minio using TLS and a self-signed certificate](#connect-console-to-a-minio-using-tls-and-a-self-signed-certificate)
2326
- [Contribute to console Project](#contribute-to-console-project)
2427

2528
<!-- markdown-toc end -->
2629

27-
### Setup
30+
## Install
31+
32+
### Binary Releases
33+
34+
| OS | ARCH | Binary |
35+
|:-------:|:-------:|:----------------------------------------------------------------------------------------------------:|
36+
| Linux | amd64 | [linux-amd64](https://github.com/minio/console/releases/latest/download/console-linux-amd64) |
37+
| Linux | arm64 | [linux-arm64](https://github.com/minio/console/releases/latest/download/console-linux-arm64) |
38+
| Linux | ppc64le | [linux-ppc64le](https://github.com/minio/console/releases/latest/download/console-linux-ppc64le) |
39+
| Linux | s390x | [linux-s390x](https://github.com/minio/console/releases/latest/download/console-linux-s390x) |
40+
| Apple | amd64 | [darwin-amd64](https://github.com/minio/console/releases/latest/download/console-darwin-amd64) |
41+
| Windows | amd64 | [windows-amd64](https://github.com/minio/console/releases/latest/download/console-windows-amd64.exe) |
42+
43+
You can also verify the binary with [minisign](https://jedisct1.github.io/minisign/) by downloading the corresponding [`.minisig`](https://github.com/minio/console/releases/latest) signature file. Then run:
44+
```
45+
minisign -Vm console-<OS>-<ARCH> -P RWTx5Zr1tiHQLwG9keckT0c45M3AGeHD6IvimQHpyRywVWGbP1aVSGav
46+
```
47+
48+
### Docker
49+
50+
Pull the latest release via:
51+
```
52+
docker pull minio/console
53+
```
54+
55+
### Build from source
56+
57+
```
58+
GO111MODULE=on go get github.com/minio/console/cmd/console
59+
```
60+
> You will need a working Go environment. Therefore, please follow [How to install Go](https://golang.org/doc/install).
61+
> Minimum version required is go1.14
62+
63+
## Setup
2864

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

3167
> Note: We don't recommend using MinIO's Operator Credentials
3268
33-
#### 1. Create a user `console` using `mc`
69+
### 1. Create a user `console` using `mc`
3470

3571
```bash
3672
mc admin user add myminio/
3773
Enter Access Key: console
3874
Enter Secret Key: xxxxxxxx
3975
```
4076

41-
#### 2. Create a policy for `console` with admin access to all resources (for testing)
77+
### 2. Create a policy for `console` with admin access to all resources (for testing)
4278

4379
```sh
4480
cat > admin.json << EOF
@@ -70,7 +106,7 @@ EOF
70106
mc admin policy add myminio/ consoleAdmin admin.json
71107
```
72108

73-
#### 3. Set the policy for the new `console` user
109+
### 3. Set the policy for the new `console` user
74110

75111
```sh
76112
mc admin policy set myminio consoleAdmin user=console
@@ -173,7 +209,8 @@ Following tree structure is expected for supporting multiple domains:
173209
## Connect Console to a Minio using TLS and a self-signed certificate
174210

175211
Copy the MinIO `ca.crt` under `~/.console/certs/CAs`, then:
176-
```
212+
213+
```sh
177214
export CONSOLE_MINIO_SERVER=https://localhost:9000
178215
./console server
179216
```

SECURITY.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ you need access credentials for a successful exploit).
1818

1919
If you have not received a reply to your email within 48 hours or you have not heard from the security team
2020
for the past five days please contact the security team directly:
21-
- Primary security coordinator: [email protected]
22-
- Secondary coordinator: [email protected], cesar@min.io
23-
- If you receive no response: [email protected]
21+
- Primary security coordinator: [email protected]
22+
- Secondary coordinator: security@min.io
23+
- If you receive no response: [email protected]
2424

2525
### Disclosure Process
2626

27-
MinIO uses the following disclosure process:
27+
MinIO Console uses the following disclosure process:
2828

2929
1. Once the security report is received one member of the security team tries to verify and reproduce
3030
the issue and determines the impact it has.
@@ -33,8 +33,8 @@ MinIO uses the following disclosure process:
3333
3. Code is audited to find any potential similar problems.
3434
4. Fixes are prepared for the latest release.
3535
5. On the date that the fixes are applied a security advisory will be published on https://blog.min.io.
36-
Please inform us in your report email whether MinIO should mention your contribution w.r.t. fixing
37-
the security issue. By default MinIO will **not** publish this information to protect your privacy.
36+
Please inform us in your report email whether MinIO Console should mention your contribution w.r.t. fixing
37+
the security issue. By default MinIO Console will **not** publish this information to protect your privacy.
3838

3939
This process can take some time, especially when coordination is required with maintainers of other projects.
4040
Every effort will be made to handle the bug in as timely a manner as possible, however it's important that we

VULNERABILITY_REPORT.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Vulnerability Management Policy
2+
3+
This document formally describes the process of addressing and managing a
4+
reported vulnerability that has been found in the MinIO Console server code base,
5+
any directly connected ecosystem component or a direct / indirect dependency
6+
of the code base.
7+
8+
### Scope
9+
10+
The vulnerability management policy described in this document covers the
11+
process of investigating, assessing and resolving a vulnerability report
12+
opened by a MinIO Console employee or an external third party.
13+
14+
Therefore, it lists pre-conditions and actions that should be performed to
15+
resolve and fix a reported vulnerability.
16+
17+
### Vulnerability Management Process
18+
19+
The vulnerability management process requires that the vulnerability report
20+
contains the following information:
21+
22+
- The project / component that contains the reported vulnerability.
23+
- A description of the vulnerability. In particular, the type of the
24+
reported vulnerability and how it might be exploited. Alternatively,
25+
a well-established vulnerability identifier, e.g. CVE number, can be
26+
used instead.
27+
28+
Based on the description mentioned above, a MinIO Console engineer or security team
29+
member investigates:
30+
31+
- Whether the reported vulnerability exists.
32+
- The conditions that are required such that the vulnerability can be exploited.
33+
- The steps required to fix the vulnerability.
34+
35+
In general, if the vulnerability exists in one of the MinIO Console code bases
36+
itself - not in a code dependency - then MinIO Console will, if possible, fix
37+
the vulnerability or implement reasonable countermeasures such that the
38+
vulnerability cannot be exploited anymore.

0 commit comments

Comments
 (0)