aottr.dev
this repo has no description
1# nox
2
3## Getting Started
4
5### Prerequisites
6
7- Go 1.18+
8
9### Installation
10
11```bash
12go install github.com/aottr/nox/cmd/nox@latest
13```
14
15## Usage
16
17### Generate age key
18
19```bash
20mkdir -p keys secrets
21```
22
23```bash
24age-keygen -o keys/key.txt
25```
26
27### Encrypt secrets
28
29```bash
30age -r <recipient> -o secrets/prod.env.age secrets/prod.env
31```
32
33### Configure
34
35Create a `config.yaml` file with the following contents:
36
37```yaml
38interval: "10m"
39age:
40 identity: "keys/key.txt"
41 recipients: # optional, when used to encrypt secrets
42 - "age1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
43statePath: ".nox-state.json"
44defaultRepo: git@github.com:ShorkBytes/nox-secrets.git
45
46apps:
47 debug:
48 branch: main
49 files:
50 - path: debug/debug.age
51 output: ./secrets/.env
52```
53
54### Run
55
56```bash
57nox --help
58```
59
60### How to
61
62#### Decrypt secret into custom file
63
64```bash
65nox decrypt --app debug --dry-run > secrets.env
66```
67
68### Contributing
69
70Contributions are welcome!
71
72```bash
73go fmt ./...
74```
75
76## License
77
78[MIT](LICENSE)