Skip to content

Commit

Permalink
docs: adds links to bundled config steps from config description.
Browse files Browse the repository at this point in the history
  • Loading branch information
outofcoffee committed Nov 17, 2023
1 parent bc4ba07 commit 17f1ea1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/config_location.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

Imposter can load configuration files from a directory or an S3 bucket.

By default, configuration files with the suffix `-config.json`, `-config.yaml` or `-config.yml` are loaded from the configuration directory.

This section describes how to load from these sources, depending on [how you run Imposter](getting_started.md).

> See [configuration discovery](config_discovery.md) for file naming and recursive loading rules.
> Also see [recursive configuration discovery](config_discovery.md) rules.
## Using the CLI

Expand Down Expand Up @@ -47,6 +49,10 @@ You can load configuration from an S3 bucket by setting the `IMPOSTER_CONFIG_DIR
docker run -e IMPOSTER_CONFIG_DIR=s3://my-bucket/path/to/config/dir outofcoffee/imposter
```

### Bundled configuration

See the Bundled Configuration section of the [deployment patterns](deployment_patterns.md#bundled-configuration) page for more information.

---

## Using Lambda
Expand All @@ -63,6 +69,8 @@ IMPOSTER_CONFIG_DIR=s3://my-bucket/path/to/config/dir

It is not possible to load configuration files from a directory when using Lambda. Instead, bundle configuration files into a ZIP file.

### Bundled configuration

To do this, use the `imposter bundle` CLI command:

```bash
Expand All @@ -71,6 +79,8 @@ imposter bundle -t awslambda /path/to/config/dir

This will create a ZIP file in the current working directory, which can be [deployed to Lambda](run_imposter_aws_lambda.md). The bundle contains both the Imposter engine and the configuration files.

> See the Bundled Configuration section of the [deployment patterns](deployment_patterns.md#bundled-configuration) page for more information.
---

## Using the JAR
Expand Down

0 comments on commit 17f1ea1

Please sign in to comment.