Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Object storage page, refresh formatting & cleanup #1465

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Prev Previous commit
Next Next commit
caching explination
  • Loading branch information
vmstan committed Jun 17, 2024
commit 9b074697a14fe82fa0c201a51337a5e87a64b6ac
9 changes: 5 additions & 4 deletions content/en/admin/optional/object-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,17 @@ Once S3 file storage is enabled, Mastodon will provide new URLs for all media 'r
These URLs can be accessed using plain HTTP GET methods, without requiring authentication.
This means that they can be routed and/or cached through reverse proxies and CDNs.

By properly configuring the URLs, you can hide the usage of the storage provider and reduce egress bandwidth costs.
You can also use host/domain names that are different from those used by the S3 storage provider itself.

{{< hint style="info" >}}
Remember to serve the files with proper CORS headers, such as `Access-Control-Allow-Origin: *`, to ensure media visibility in the user's browser and proper functioning of Mastodon's web UI.
{{</ hint >}}

It is highly recommended to use a domain (or subdomain) that you control for delivering S3 stored media.
This provides flexibility in case you decide to change S3 providers in the future.
By properly configuring the URLs, you can hide the usage of the storage provider and use caching to reduce egress bandwidth costs.
It also ensures that the address for your file storage, which may have already federated to other servers for older posts, remains accessible even if you need to change the storage provider's address.

This provides flexibility in case you decide to change S3 providers in the future. It also ensures that the address for your file storage, which may have already federated to other servers for older posts, remains accessible even if you need to change the storage provider's address.
Some S3 providers, such as DigitalOcean Spaces, provide integrated CDN/caching services as part of the S3 service.
For others, you will need to configure this manually or partner with another provider.

{{< page-ref page="admin/optional/object-storage-proxy.md" >}}

Expand Down