{"id":22725351,"url":"https://github.com/ovotech/ssm-env-secrets","last_synced_at":"2025-07-17T05:35:04.470Z","repository":{"id":57134603,"uuid":"159015038","full_name":"ovotech/ssm-env-secrets","owner":"ovotech","description":"Load secrets from ssm transparently","archived":false,"fork":false,"pushed_at":"2019-01-18T15:51:36.000Z","size":75,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":27,"default_branch":"master","last_synced_at":"2024-12-05T15:11:29.695Z","etag":null,"topics":["aws","boostpower"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ovotech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-25T09:12:18.000Z","updated_at":"2020-07-13T13:56:49.000Z","dependencies_parsed_at":"2022-09-04T09:11:33.182Z","dependency_job_id":null,"html_url":"https://github.com/ovotech/ssm-env-secrets","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovotech%2Fssm-env-secrets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovotech%2Fssm-env-secrets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovotech%2Fssm-env-secrets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovotech%2Fssm-env-secrets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ovotech","download_url":"https://codeload.github.com/ovotech/ssm-env-secrets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229089204,"owners_count":18018390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","boostpower"],"created_at":"2024-12-10T16:09:24.553Z","updated_at":"2024-12-10T16:09:25.098Z","avatar_url":"https://github.com/ovotech.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SSM ENV Secrets\n\n[![CircleCI](https://circleci.com/gh/ovotech/ssm-env-secrets.svg?style=svg\u0026circle-token=d9be710126b12e0271cb77a09d08a7e2129ba112)](https://circleci.com/gh/ovotech/ssm-env-secrets)\n[![npm (scoped)](https://img.shields.io/npm/v/@ovotech/ssm-env-secrets.svg)](https://www.npmjs.com/package/@ovotech/ssm-env-secrets)\n\nThis function is loads data from AWS Systems Manager (SSM) Parameter Store. This way you can securely store secrets and retrieve them at runtime in production, but rely on dummy values in dev/testing.\n\nThis module ships with TypeScript types.\n\n### Using\n\n```bash\nyarn add @ovotech/ssm-env-secrets\n```\n\nIf you have a parameter in SSM Parameter store called `my-secret-key` with your secret value. And your env vars look like this:\n\n```\nNODE_ENV=something\nAPI_ID=my-id\nAPI_KEY=ssm://my-secret-key\n```\n\nThen you can load the secret values with:\n\n```ts\nimport { loadSSMSecrets } from '@ovotech/ssm-env-secrets';\nimport { SSM } from 'aws-sdk';\n\nconst ssm = new SSM({ region: 'eu-west-1' });\nconst env = loadSSMSecrets(ssm, process.env);\n\nconsole.log(env.API_KEY); // will hold the decrypted value of \"my-secret-key\" parameter\n```\n\n## Running the tests\n\nThe tests require a running ssm mock server, and we're using [localstack](https://github.com/localstack/localstack) for that.\nYou'll need to start the ssm server:\n\n```bash\nSERVICES=ssm localstack start\n```\n\nAfter which you can run all the tests:\n\n```bash\nyarn test\n```\n\n### Coding style (linting, etc) tests\n\nStyle is maintained with prettier and tslint\n\n```\nyarn lint\n```\n\n## Deployment\n\nTo deploy a new version, push to master and then create a new release. CircleCI will automatically build and deploy a the version to the npm registry.\n\n## Contributing\n\nHave a bug? File an issue with a simple example that reproduces this so we can take a look \u0026 confirm.\n\nWant to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see `test/S3DataSource.spec.ts`). You can run the tests with `SERVICES=ssm localstack start` and `yarn test`.\n\n## Responsible Team\n\n- Boost Internal Tools (BIT)\n\n## License\n\nThis project is licensed under Apache 2 - see the [LICENSE](LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovotech%2Fssm-env-secrets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fovotech%2Fssm-env-secrets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovotech%2Fssm-env-secrets/lists"}