https://github.com/simplicitesoftware/module-minio
https://github.com/simplicitesoftware/module-minio
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/simplicitesoftware/module-minio
- Owner: simplicitesoftware
- Created: 2025-08-04T14:54:22.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-08-04T16:50:22.000Z (11 months ago)
- Last Synced: 2025-08-04T19:57:57.511Z (11 months ago)
- Language: Java
- Size: 26.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
* * *
`Minio` module definition
=========================
Minio S3 cloud storage example
------------------------------
### Prerequisites
1. Install Minio server
See [this page](https://docs.min.io/community/minio-object-store/index.html).
You should install both the server and the `mc` CLI client.
For a local deployment the storage server's S3 endpoint is `http://127.0.0.1:9000`
You can alias it as `local`:
```text
mc alias set local http://127.0.0.1:9000 minioadmin minioadmin
mc admin info local
```
> note: the objects browser UI is also available on `http://127.0.0.1:9001`.
2. Create credentials
```text
mc admin accesskey create local
```
The result should look like:
```text
Access Key:
Secret Key:
Expiration: NONE
Name:
Description:
```
3. Create a `test` bucket
```text
mc mb local/test
```
4. Review the `MINIO_CONFIG` system param to comply with your Minio server configuration
The default value of the system parameter is using the follwoing environment variables:
- `MINIO_ENDPOINT`: API endpoint (e.g. `http://127.0.0.1:9000`)
- `MINIO_BUCKET`: bucket name (e.g. `test`)
- `MINIO_ACCESSKEY` and `MINIO_SECRETKEY`: credentials
### Docker
Add the `minio` service to you `docker-compose.yml`:
```yaml
services:
minio:
image: quay.io/minio/minio:latest
command: [ "server" ]
ports:
- 127.0.0.1:9000:9000
volumes:
- :/data
```
Create the credentials and the bucket locally using the `mc` CLI
(once done you can remove the `9000` port mapping)
and add the following environment variabled to your `simplicite` service:
```yaml
environment:
MINIO_ENDPOINT: "http://minio:9000"
MINIO_BUCKET: ""
MINIO_ACCESSKEY: ""
MINIO_SECRETKEY: ""
```
`MinioTest` business object definition
--------------------------------------
### Fields
| Name | Type | Required | Updatable | Personal | Description |
|--------------------------------------------------------------|------------------------------------------|----------|-----------|----------|----------------------------------------------------------------------------------|
| `minioTstCode` | char(50) | yes* | yes | | - |
| `minioTstLabel` | char(255) | | yes | | - |
| `minioTstDocument` | document | | yes | | - |