Skip to content

Update documentation to include more information on Cloudflare R2 credentials #241

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.

Sign up for GitHub

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

Merged
blake-mealey merged 2 commits into from
May 24, 2025
Merged

Update documentation to include more information on Cloudflare R2 credentials #241

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04dcb12
docs: clarify environment variable identifiers for cloudflare r2 use …
OphidieDev May 24, 2025
fb9e896
docs: add comma to authentication page
OphidieDev May 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/site/pages/docs/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ set your environment variable in various ways, like the following:

## Remote state management

Mantle supports managing remote state files using AWS S3 storage which requires authentication. You can
Mantle supports managing remote state files using AWS S3 or Cloudflare R2 storage which requires authentication. You can
provide your credentials either through environment variables or [an AWS profile
file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html#cli-configure-profiles-create).

Expand All @@ -150,7 +150,8 @@ getting your AWS credentials](https://docs.aws.amazon.com/general/latest/gr/aws-

The simplest method is to set the `MANTLE_AWS_ACCESS_KEY_ID` and `MANTLE_AWS_SECRET_ACCESS_KEY` environment
variables. Mantle also supports the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` variables but recommends
you scope your variables to Mantle to avoid conflicts with other tools.
you scope your variables to Mantle to avoid conflicts with other tools. Cloudflare R2 is compatible with
this same authentication scheme, so you can input your secret access key and key ID into the same environment variables.

If you're using Mantle within an AWS EC2 instance or AWS Elastic Container Service, you can set the
`MANTLE_AWS_INHERIT_IAM_ROLE` environment variable to `true` to inherit the permission set granted to the host
Expand Down
Loading