mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-23 02:06:29 -05:00
bd92010dd2
This removes the only camel cased option of the config options **we** added to the config.json. In auth provider's config parts are a lot of camel cased options provided. We shouldn't touch them to keep them as similar as possible to the examples. Fixes #315 Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
83 lines
2 KiB
Markdown
83 lines
2 KiB
Markdown
Minio Guide for HackMD
|
|
===
|
|
|
|
1. First of all you need to setup Minio itself.
|
|
|
|
Please refer to the [official Minio docs](https://docs.minio.io/) for an
|
|
production setup.
|
|
|
|
For checking it out and development purposes a non-persistent setup is enough:
|
|
```console
|
|
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*
|
|
|
|
2. Next step is to get the credentials form the container:
|
|
|
|
```
|
|
docker logs test-minio
|
|
```
|
|
|
|
|
|
|
|
3. Open http://localhost:9000 and login with the shown credentials.
|
|
|
|
|
|
|
|
4. Create a bucket for HackMD
|
|
|
|
|
|
|
|
5. Add a policy for the prefix `uploads` and make it read-only.
|
|
|
|
|
|
*Open policy editor*
|
|
|
|
|
|
*Add policy for uploads*
|
|
|
|
6. Set credentials and configs for Minio in HackMD's `config.json`
|
|
|
|
```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.*
|
|
|
|
7. Set bucket name
|
|
|
|
```JSON
|
|
"s3bucket": "hackmd"
|
|
```
|
|
|
|
8. Set upload type.
|
|
|
|
```JSON
|
|
"imageuploadtype": "minio"
|
|
```
|
|
|
|
9. Review your config.
|
|
|
|
```json
|
|
{
|
|
// all your other config…
|
|
"minio": {
|
|
"accessKey": "888MXJ7EP4XXXXXXXXX",
|
|
"secretKey": "yQS2EbM1Y6IJrp/1BUKWq2/XXXXXXXXXXXXXXX",
|
|
"endPoint": "localhost",
|
|
"port": 9000,
|
|
"secure": false
|
|
},
|
|
"s3bucket": "hackmd",
|
|
"imageuploadtype": "minio"
|
|
}
|
|
```
|