Envy
June 21, 2024 ยท View on GitHub
Envy loads and sets environment variables from YAML. It supports all YAML data types, including arrays and hashes.
Envy uses the YAML key mapping of a value as the environment variable name. For example, the following YAML configuration...
---
app:
database:
host: localhost
port: 4321
server:
hosts:
- localhost
- grottopress.localhost
port: 8080
webhooks:
- url: "https://example.com"
token: "a1b2c2"
- url: "https://myapp.net"
token: "d4e5f6"
...sets environment variables as follows:
ENV["APP_DATABASE_HOST"] = "localhost"
ENV["APP_DATABASE_PORT"] = "4321"
ENV["APP_SERVER_HOSTS_0"] = "localhost"
ENV["APP_SERVER_HOSTS_1"] = "grottopress.localhost"
ENV["APP_SERVER_PORT"] = "8080"
ENV["APP_WEBHOOKS_0_URL"] = "https://example.com"
ENV["APP_WEBHOOKS_0_TOKEN"] = "a1b2c2"
ENV["APP_WEBHOOKS_1_URL"] = "https://myapp.net"
ENV["APP_WEBHOOKS_1_TOKEN"] = "d4e5f6"
It sets file permission (0600 by default) for all config files.
Envy supports loading a file from a supplied list of files in decreasing order of priority; the first readable file is loaded.
Installation
-
Add the dependency to your
shard.yml:dependencies: envy: github: GrottoPress/envy -
Run
shards install
Usage
-
Load the first readable file from a supplied list of files. Optionally set files permissions. This does not overwrite existing environment variables:
require "envy" Envy.from_file ".env.yml", ".env.dev.yml", perm: 0o400 -
Load the first readable file from a supplied list of files. Optionally set files permissions. This overwrites existing environment variables:
require "envy" Envy.from_file! ".env.yml", ".env.dev.yml", perm: 0o400
Contributing
- Fork it
- Switch to the
masterbranch:git checkout master - Create your feature branch:
git checkout -b my-new-feature - Make your changes, updating changelog and documentation as appropriate.
- Commit your changes:
git commit - Push to the branch:
git push origin my-new-feature - Submit a new Pull Request against the
GrottoPress:masterbranch.