Package Exports

docker-secret
docker-secret/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docker-secret) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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:

`secrets`

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

import { secrets } from "docker-secret";

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

`getSecrets<Secrets>(dir?: string): Secrets`

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

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<Credentials>(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<Credentials>();