mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-09-20 07:59:03 -04:00
9c2e47dcc4
This adds documentation for the configuration of HedgeDoc. Signed-off-by: Philip Molares <philip.molares@udo.edu>
19 lines
930 B
Markdown
19 lines
930 B
Markdown
# S3-compatible
|
|
|
|
You can use [Amazon S3](https://aws.amazon.com/s3/) or any other S3-compatible storage (like [MinIO](https://min.io) or [Ceph Object Gateway](https://docs.ceph.com/en/latest/radosgw/)) to handle your image uploads in HedgeDoc.
|
|
|
|
Your S3 bucket must be configured to be writeable.
|
|
|
|
You just add the following lines to your configuration:
|
|
<small>(with the appropriate substitution for `<ACCESS_KEY>`, `<SECRET_KEY>`, `<BUCKET>`, and `<ENDPOINT>` of course)</small>
|
|
```
|
|
HD_MEDIA_BACKEND="s3"
|
|
HD_MEDIA_BACKEND_S3_ACCESS_KEY="<ACCESS_KEY>"
|
|
HD_MEDIA_BACKEND_S3_SECRET_KEY="<SECRET_KEY>"
|
|
HD_MEDIA_BACKEND_S3_BUCKET="<BUCKET>"
|
|
HD_MEDIA_BACKEND_S3_ENDPOINT="<ENDPOINT>"
|
|
```
|
|
|
|
If you use Amazon S3, `<ENDPOINT>` should contain your [Amazon Region](https://docs.aws.amazon.com/general/latest/gr/s3.html).
|
|
|
|
For example: If your Amazon Region is `us-east-2`, your endpoint `<ENDPOINT>` should be `s3.us-east-2.amazonaws.com`.
|