github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-01 16:01:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/config/media/s3.md
Tilman Vatteroth d8c1e35819 docs(docs): make clear that the s3 endpoint must be a URL 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-04-16 18:41:03 +02:00

1.1 KiB
Raw Blame History

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>"

<ENDPOINT> should be an URL and contain the protocol, the domain and if necessary the port. For example: https://s3.example.org or http://s3.example.org:9000

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 https://s3.us-east-2.amazonaws.com.