docker-secret

Utility for retrieving docker secrets.

Usage

Given that you have created secrets for your docker swarm

``
printf "myUsername" | docker secret create USERNAME -
printf "mySuperSecret" | docker secret create PASSWORD -
`

You can retrieve secrets via the following methods:

$3

Loads secrets defined in the /run/secrets directory. To load from a different directory, refer to getSecrets(dir).

`ts
import { secrets } from "docker-secret";

// Use secrets in your app.
mongoose.connect(
mongodb://${secrets.USERNAME}:${secrets.PASSWORD}@mongodb/mydb
);
`

$3

You can read secrets from a directory you define. This is useful for loading secrets from a different directory during development.

`ts
import { getSecrets } from "docker-secret";

// Without typings works fine
const secrets = getSecrets(process.env.SECRET_DIR);

secrets.USERNAME; // no error
secrets.PASSWORD; // no error
secrets.RANDOM; // no error

// But using with typings is preferred
type Credentials = {
USERNAME: string;
PASSWORD: string;
};

const secrets = getSecrets(process.env.SECRET_DIR);

secrets.USERNAME; // no error
secrets.PASSWORD; // no error
secrets.RANDOM; // error

// You can also call the function without any argument to load secrets from /run/secrets by default.
const secrets = getSecrets();
``