config-secret

config-secret is an additional source for the config crate that follows the Docker/Kubernetes convention.

It allows to inject some parts of your configuration by using a file specified as environment variable. See examples.

Installation

toml [dependencies] config = "0.13" config-secret = "0.1.0"

Usage

```rust use config::Config; use config_secret::EnvironmentSecretFile;

let source = EnvironmentSecretFile::withprefix("APP").separator(""); let config = Config::builder().addsource(source).build().unwrap(); let settings = config.trydeserialize::().unwrap();

// settings... ```

Examples

Definition

Let's introduce our types and our config initializer:

```rust use config::{Config, ConfigError}; use config_secret::EnvironmentSecretFile; use serde::Deserialize;

[derive(Deserialize, Clone, Debug)]

pub struct Settings { pub server: ServerSettings, pub redis: RedisSettings, }

[derive(Deserialize, Clone, Debug)]

pub struct ServerSettings { pub host: String, pub port: u16, }

[derive(Deserialize, Clone, Debug)]

pub struct RedisSettings { pub nodes: Vec, pub username: Option, pub password: Option, }

pub fn getsettings() -> Result { let config = Config::builder() .addsource( config::Environment::withprefix("APP") .separator("") .listseparator(",") .withlistparsekey("redis.nodes") .tryparsing(true), ) .addsource( EnvironmentSecretFile::withprefix("APP") .separator("") ) .build()?;

config.try_deserialize::<Settings>()

} ```

Full configuration

We can add an environment variable to set a secret that configure the whole configuration:

env APP_FILE=/run/secrets/my_secret.json json { "server": { "host": "0.0.0.0", "port": 5000 }, "redis": { "nodes": [ "redis://10.0.0.1:6379", "redis://10.0.0.2:6379", "redis://10.0.0.3:6379" ] } } rust let settings = get_settings().unwrap(); assert!(settings.server.host == "0.0.0.0");

Partial configuration

We can add environments variables that set only a sub section of your configuration:

```env APPSERVERHOST=127.0.0.1 APPSERVERPORT=5000

APPREDISFILE=/run/secrets/redis.yaml yaml nodes: - redis://10.0.0.1:6379 - redis://10.0.0.2:6379 - redis://10.0.0.3:6379 username: redis password: superpassword rust let settings = get_settings().unwrap(); assert!(settings.server.host == "127.0.0.1"); assert!(settings.redis.username == "redis"); ```

License

MIT