Minio Guide for CodiMD

Note: This guide was written before the renaming. Just replace HackMD with CodiMD in your mind

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

thanks!

First of all you need to setup Minio itself.

Please refer to the official Minio docs for an production setup.

For checking it out and development purposes a non-persistent setup is enough:
```
docker run --name test-minio --rm -d -p 9000:9000 minio/minio server /data
```
Please notice this is not for productive use as all your data gets lost when you stop this container
Next step is to get the credentials form the container:
```
docker logs test-minio
```
Open http://localhost:9000 and login with the shown credentials.
Create a bucket for HackMD
Add a policy for the prefix uploads and make it read-only.

Open policy editor

Add policy for uploads

Set credentials and configs for Minio in HackMD's config.json

"minio": {
  "accessKey": "888MXJ7EP4XXXXXXXXX",
  "secretKey": "yQS2EbM1Y6IJrp/1BUKWq2/XXXXXXXXXXXXXXX",
  "endPoint": "localhost",
  "port": 9000,
  "secure": false
}

You have to use different values for endpoint and port for a production setup. Keep in mind the endpoint-address has to be public accessible from your browser.

Set bucket name
```
"s3bucket": "hackmd"
```
Set upload type.
```
"imageuploadtype": "minio"
```

Review your config.

{
  // all your other config…
  "minio": {
    "accessKey": "888MXJ7EP4XXXXXXXXX",
    "secretKey": "yQS2EbM1Y6IJrp/1BUKWq2/XXXXXXXXXXXXXXX",
    "endPoint": "localhost",
    "port": 9000,
    "secure": false
  },
  "s3bucket": "hackmd",
  "imageuploadtype": "minio"
}

Minio Guide for CodiMD

tags: CodiMD Docs

tags: `CodiMD` `Docs`