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

Added config guidance for new users #68

Merged
merged 1 commit into from
Sep 11, 2020
Merged
Changes from all commits
Commits
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
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,33 @@ docker run \
`stim deploy` makes it easier to deploy with a simple config file. See [docs/DEPLOY.md](docs/DEPLOY.md) for more details.

## Examples
See the [examples directory](examples) for examples of certain subocommands.
See the [examples directory](examples) for examples of certain subcommands.

## Configuration

In addition to accepting config via CLI options and environment variables, Stim reads configuration from a file (`${HOME}/.stim/config.yaml` by default). You can pass alternate config file paths at runtime via the `--config` CLI option, for example:

```
stim vault login --config ~/.stim/alt-config-file.yaml
```

Configuration files are YAML-formatted and allow you to configure settings for AWS, Vault, logging, etc. For a full list of configuration options and related info, see the [Config documentation](docs/CONFIG.md). A sample configuration file for a Vault instance in which you use Github as an auth backend might look like:

```
auth:
# the name of a pre-configured Vault auth method
method: github
aws:
default-profile: true
ttl: 10h
use-profiles: true
web-ttl: 10h
# the URL of your Vault instance
vault-address: https://vault.example.com
vault-initial-token-duration: 10h
vault-username: github-login
vault-username-skip-prompt: true
```

## Developing with Stim

Expand Down