Skip to content

Commit

Permalink
Document new config loading features
Browse files Browse the repository at this point in the history
  • Loading branch information
MaeIsBad committed Dec 13, 2023
1 parent 137c1f5 commit 797df01
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Load configuration from the `LOCALAUTH0_CONFIG` environment variable

### Changed

- Load configuration from `localauth0.toml` by default

---

## [0.6.2] - 2023-10-27
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,9 @@ The page will automatically redirect to:

## Configuration

Localauth0 can be configured using a `.toml` file (see [localauth0.toml](localauth0.toml) as an example),
which can be specified using the `LOCALAUTH0_CONFIG_PATH` environment variable.
Localauth0 can be configured using a `localauth0.toml` file (see [localauth0.toml](localauth0.toml) as an example)
or using the `LOCALAUTH0_CONFIG` environment variable.

Take a look [here](#Integrate-localauth0-in-existing-project) to see how to configure your docker compose cluster.

### Local development
Expand Down Expand Up @@ -174,7 +175,13 @@ Add this snippet to your `docker-compose.yml` file and reference it in your app
auth0:
image: public.ecr.aws/c6i9l4r6/localauth0:0.6.2
environment:
LOCALAUTH0_CONFIG_PATH: /etc/localauth0.toml
# Configure using an inline environment variable
LOCALAUTH0_CONFIG: |
issuer = "https://prima.localauth0.com/"
[user_info]
given_name = "Locie"

# Or using a config file
volumes:
- ./localauth0.toml:/etc/localauth0.toml:ro
ports:
Expand Down

0 comments on commit 797df01

Please sign in to comment.