mcs

command module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 23, 2020 License: AGPL-3.0 Imports: 10 Imported by: 0

README

Minio Console Server

A graphical user interface for MinIO

Dashboard Adding A User
Dashboard Dashboard

Setup

All mcs 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

  1. Create a user for mcs using mc.
$ set +o history
$ mc admin user add myminio mcs YOURMCSSECRET
$ set -o history
  1. Create a policy for mcs with access to everything (for testing and debugging)
$ cat > mcsAdmin.json << EOF
{
	"Version": "2012-10-17",
	"Statement": [{
			"Action": [
				"admin:*"
			],
			"Effect": "Allow",
			"Sid": ""
		},
		{
			"Action": [
                "s3:*"
			],
			"Effect": "Allow",
			"Resource": [
				"arn:aws:s3:::*"
			],
			"Sid": ""
		}
	]
}
EOF
$ mc admin policy add myminio mcsAdmin mcsAdmin.json
  1. Set the policy for the new mcs user
$ mc admin policy set myminio mcsAdmin user=mcs
Note

Additionally, you can create policies to limit the privileges for mcs 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:

{
	"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": ""
		}
	]
}

Run MCS server

To run the server:

export MCS_HMAC_JWT_SECRET=YOURJWTSIGNINGSECRET

#required to encrypt jwet payload
export MCS_PBKDF_PASSPHRASE=SECRET

#required to encrypt jwet payload
export MCS_PBKDF_SALT=SECRET

export MCS_ACCESS_KEY=mcs
export MCS_SECRET_KEY=YOURMCSSECRET
export MCS_MINIO_SERVER=http://localhost:9000
./mcs server

Connect MCS to a Minio using TLS and a self-signed certificate

...
export MCS_MINIO_SERVER_TLS_ROOT_CAS=<certificate_file_name>
export MCS_MINIO_SERVER=https://localhost:9000
./mcs server

You can verify that the apis work by doing the request on localhost:9090/api/v1/...

Contribute to mcs Project

Please follow mcs Contributor's Guide

Documentation

Overview

Code generated for package main by go-bindata DO NOT EDIT. (@generated) sources: portal-ui/build/android-icon-144x144.png portal-ui/build/android-icon-192x192.png portal-ui/build/android-icon-36x36.png portal-ui/build/android-icon-48x48.png portal-ui/build/android-icon-72x72.png portal-ui/build/android-icon-96x96.png portal-ui/build/apple-icon-180x180.png portal-ui/build/asset-manifest.json portal-ui/build/favicon-16x16.png portal-ui/build/favicon-32x32.png portal-ui/build/favicon-96x96.png portal-ui/build/favicon.ico portal-ui/build/images/BG_Illustration.svg portal-ui/build/index.html portal-ui/build/logo192.png portal-ui/build/logo512.png portal-ui/build/manifest.json portal-ui/build/precache-manifest.74a2d269d0e005f51565256b6a5fe900.js portal-ui/build/robots.txt portal-ui/build/safari-pinned-tab.svg portal-ui/build/service-worker.js portal-ui/build/static/css/main.d5fff3f6.chunk.css portal-ui/build/static/css/main.d5fff3f6.chunk.css.map portal-ui/build/static/js/2.4c1d8bf4.chunk.js portal-ui/build/static/js/2.4c1d8bf4.chunk.js.LICENSE.txt portal-ui/build/static/js/2.4c1d8bf4.chunk.js.map portal-ui/build/static/js/main.a32ca715.chunk.js portal-ui/build/static/js/main.a32ca715.chunk.js.map portal-ui/build/static/js/runtime-main.4f8a9e73.js portal-ui/build/static/js/runtime-main.4f8a9e73.js.map portal-ui/build/static/media/mkube_logo_temp.279ba91b.svg

Directories

Path Synopsis
cmd
mcs
This package imports things required by build scripts, to force `go mod` to see them as dependencies
This package imports things required by build scripts, to force `go mod` to see them as dependencies
pkg
acl
apis/networking.gke.io/v1beta1
Package v1beta1 is v1beta1 version of the API.
Package v1beta1 is v1beta1 version of the API.
apis/networking.gke.io/v1beta2
Package v1beta2 is v1beta2 version of the API.
Package v1beta2 is v1beta2 version of the API.
auth/idp/oauth2
Package oauth2 contains all the necessary configurations to initialize the idp communication using oauth2 protocol
Package oauth2 contains all the necessary configurations to initialize the idp communication using oauth2 protocol
clientgen/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
clientgen/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
clientgen/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
clientgen/clientset/versioned/typed/networking.gke.io/v1beta2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientgen/clientset/versioned/typed/networking.gke.io/v1beta2/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
Code generated for package portal by go-bindata DO NOT EDIT.
Code generated for package portal by go-bindata DO NOT EDIT.
Package restapi MinIO Console Server Schemes: http ws Host: localhost BasePath: /api/v1 Version: 0.1.0 Consumes: - application/json Produces: - application/octet-stream - application/json swagger:meta
Package restapi MinIO Console Server Schemes: http ws Host: localhost BasePath: /api/v1 Version: 0.1.0 Consumes: - application/json Produces: - application/octet-stream - application/json swagger:meta

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL