dotsec 4.0.0-alpha.34 → 4.0.0-alpha.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +15 -6
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [4.0.0-alpha.35](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.34...v4.0.0-alpha.35) (2023-08-17)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package dotsec
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
# [4.0.0-alpha.34](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.33...v4.0.0-alpha.34) (2023-08-17)
|
|
7
15
|
|
|
8
16
|
|
package/README.md
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
1
|
# dotsec
|
|
2
2
|
|
|
3
|
-
The solution offers encryption and decryption of `.env` files to and from `.sec` files, the ability to run a command with the values of a `.env`/`.sec` file in its environment
|
|
4
|
-
|
|
3
|
+
The solution offers encryption and decryption of `.env` files to and from `.sec` files, the ability to run a command with the values of a `.env`/`.sec` file in its environment. The AWS plugin adds the ability to push selected `.env`/`.sec` entries to AWS Systems Manager Parameter Store and AWS Secrets Manager.
|
|
4
|
+
|
|
5
|
+
Currently there are two methods of encryption supported:
|
|
6
|
+
|
|
7
|
+
- [`@dotsec/plugin-pke`](./packages/plugin-pke/README.md) - Using Public Key Encryption
|
|
8
|
+
- [`@dotsec/plugin-aws`](./packages/plugin-aws/README.md) - Using AWS Key Management Service (AWS KMS)
|
|
9
|
+
|
|
10
|
+
## Why?
|
|
11
|
+
|
|
12
|
+
Environment variables are a great way to configure your application. However, they shouldn't be committed to your repository. This is because they often contain sensitive information, like passwords, API keys, and other secrets. This is where `dotsec` comes in. It allows you to encrypt your environment variables, and store them in a `.sec` file, which can be committed to your repository.
|
|
5
13
|
|
|
6
14
|
## Features
|
|
7
15
|
|
|
@@ -44,9 +52,9 @@ import { DotsecPluginAws } from "@dotsec/plugin-aws";
|
|
|
44
52
|
import { DotsecConfig } from "dotsec";
|
|
45
53
|
|
|
46
54
|
export const dotsec: DotsecConfig<{ plugins: DotsecPluginAws }> = {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
55
|
+
defaults: {
|
|
56
|
+
encryptionEngine: "aws",
|
|
57
|
+
},
|
|
50
58
|
};
|
|
51
59
|
```
|
|
52
60
|
|
|
@@ -110,7 +118,8 @@ npx dotsec push
|
|
|
110
118
|
```
|
|
111
119
|
|
|
112
120
|
> You might want to set AWS_REGION before running the command. If you don't, the region will be set to `eu-west-1`.
|
|
113
|
-
|
|
121
|
+
|
|
122
|
+
<!--
|
|
114
123
|
## Usage
|
|
115
124
|
|
|
116
125
|
If you don't have an AWS KMS key with an alias, you can create one with the following command:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dotsec",
|
|
3
|
-
"version": "4.0.0-alpha.
|
|
3
|
+
"version": "4.0.0-alpha.35",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
"typescript": "~4.9.3",
|
|
64
64
|
"yargs-parser": "^21.1.1"
|
|
65
65
|
},
|
|
66
|
-
"gitHead": "
|
|
66
|
+
"gitHead": "f73350337af34572d6d9b90ed34710bb8859b1ad"
|
|
67
67
|
}
|