https://github.com/hwkd/docker-secret
Utility for retrieving docker secrets.
https://github.com/hwkd/docker-secret
docker docker-secret kubernetes nodejs secrets swarm
Last synced: 4 months ago
JSON representation
Utility for retrieving docker secrets.
- Host: GitHub
- URL: https://github.com/hwkd/docker-secret
- Owner: hwkd
- License: mit
- Created: 2019-02-12T00:31:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T09:46:17.000Z (almost 3 years ago)
- Last Synced: 2025-10-06T04:30:29.180Z (9 months ago)
- Topics: docker, docker-secret, kubernetes, nodejs, secrets, swarm
- Language: TypeScript
- Homepage:
- Size: 832 KB
- Stars: 16
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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)`](#getsecretsdir).
```ts
import { secrets } from "docker-secret";
// Use secrets in your app.
mongoose.connect(
`mongodb://${secrets.USERNAME}:${secrets.PASSWORD}@mongodb/mydb`
);
```
### `getSecrets(dir?: string): Secrets`
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();
```