Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
110 lines (76 loc) · 2.62 KB

DEVELOPMENT.md

File metadata and controls

110 lines (76 loc) · 2.62 KB

Developing Console

Console requires the MinIO® Server. For development purposes, you also need to run both the Console web app and the Console server.

Important

MINIO is a registered trademark of the MinIO Corporation. Consequently, this project is not affiliated with or endorsed by the MinIO Corporation.

Console Architecture Overview

graph TD;
    A(User Browser) -- HTTPS/HTTP --> B["Console<br>Frontend Application<br>(React/TypeScript)"];
    B -- REST API Calls --> D["Console<br>Backend Server<br>(Go)"];
    D -- "HTTPS/HTTP<br>Admin Operations" --> E["MinIO Server<br>Object Storage"];
    E@{ shape: cyl}
Loading

Running Console server

Build the server in the main folder by running:

make

Note

If it's the first time running the server, you might need to run go mod tidy to ensure you have all modules required.

To start the server run:

CONSOLE_ACCESS_KEY=<your-access-key>
CONSOLE_SECRET_KEY=<your-secret-key>
CONSOLE_MINIO_SERVER=<minio-server-endpoint>
CONSOLE_DEV_MODE=on
./console server

Running Console web app

Refer to /web-app instructions to run the web app locally.

Building with MinIO

To test console in its shipping format, you need to build it from the MinIO repository, the following step will guide you to do that.

0. Building with UI Changes

If you are performing changes in the UI components of console and want to test inside the MinIO binary, you need to build assets first.

In the console folder run

make assets

This will regenerate all the static assets that will be served by MinIO.

1. Clone the MinIO repository

In the parent folder of where you cloned this console repository, clone the MinIO Repository

git clone https://github.com/minio/minio.git

2. Update go.mod to use your local version

In the MinIO repository open go.mod and after the first require() directive add a replace() directive

...
)

replace (
github.com/minio/console => "../console"
)

require (
...

3. Build MinIO

Still in the MinIO folder, run

make build

Testing with a Container

If you want to test console in a container, you can perform all the steps from Building with MinIO, but change Step 3 to the following:

TAG=miniodev/console:dev make docker

This will build a docker container image that can be used to test with.

You can use it in your local kubernetes environment aswell.

For example, if you are using kind:

kind load docker-image miniodev/console:dev

and then deploy any Tenant that uses this image