Skip to content

Commit

Permalink
Add documentation for IAM env var
Browse files Browse the repository at this point in the history
  • Loading branch information
TreehouseFalcon committed Dec 7, 2023
1 parent 38dbd1a commit 4a1ede2
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/site/pages/docs/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { Callout, Tabs, Tab } from 'nextra-theme-docs';
import { Callout, Tabs, Tab } from "nextra-theme-docs";

# Authentication

<Callout type="error">
Remember to never save your secrets in source control or any insecure
environment. Anybody who gets access to them could use them to steal your
accounts.
Remember to never save your secrets in source control or any insecure environment. Anybody who
gets access to them could use them to steal your accounts.
</Callout>

## Resource management
Expand Down Expand Up @@ -112,6 +111,10 @@ The simplest method is to set the `MANTLE_AWS_ACCESS_KEY_ID` and `MANTLE_AWS_SEC
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.

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
runner via either the EC2 instance's IAM role or the Elastic Container Service task execution IAM role.

You can set your environment variables in various ways, like the following:

<Tabs items={["dotenv file", "Windows (PowerShell)", "MacOS/Linux (Bash)"]}>
Expand Down

0 comments on commit 4a1ede2

Please sign in to comment.