Skip to content

Commit b808321

Browse files
authored
Update Dev Docs with MinIO naming conventions (#2783)
1 parent 61c864e commit b808321

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

DEVELOPMENT.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
# Developing Console
1+
# Developing MinIO Console
22

3-
Console requires to have the [MinIO](https://github.com/minio/minio) server, Console server and the Console web app running.
3+
The MinIO Console requires the [MinIO Server](https://github.com/minio/minio). For development purposes, you also need to run both the MinIO Console web app and the MinIO Console server.
44

5-
## Running Server
5+
## Running MinIO Console server
66

77
Build the server in the main folder by running:
88
```
99
make
1010
```
1111
> 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.
12-
1312
To start the server run:
1413
```
1514
CONSOLE_ACCESS_KEY=<your-access-key>
1615
CONSOLE_SECRET_KEY=<your-secret-key>
17-
CONSOLE_MINIO_SERVER=<minio-endpoint>
16+
CONSOLE_MINIO_SERVER=<minio-server-endpoint>
1817
CONSOLE_DEV_MODE=on
1918
./console server
2019
```
2120

22-
## Running Web app
21+
## Running MinIO Console web app
2322
Refer to `/portal-ui` [instructions](/portal-ui/README.md) to run the web app locally.
2423

2524

0 commit comments

Comments
 (0)