hedgedoc/docs/content/config/media/s3.md
Philip Molares 0512308159 Docs: Add configuration documentation
This adds documentation for the configuration of HedgeDoc.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-08-05 21:43:29 +02:00

930 B

S3-compatible

You can use Amazon S3 or any other S3-compatible storage (like MinIO or Ceph Object Gateway) 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:
(with the appropriate substitution for <ACCESS_KEY>, <SECRET_KEY>, <BUCKET>, and <ENDPOINT> of course)

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.

For example: If your Amazon Region is us-east-2, your endpoint <ENDPOINT> should be s3.us-east-2.amazonaws.com.