spencer/envr
1
0
Fork 0
mirror of https://github.com/sbrow/envr.git synced 2026-06-27 10:38:33 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: updated README.md

Browse Source
This commit is contained in:
Spencer Brower
2026-06-12 16:53:38 -04:00
parent 930c3d4c5d
commit ad3ce748bb
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -13,7 +13,7 @@ the tool [of your choosing](#backup-options).
## Features ## Features
- 🔐 **Encrypted Storage**: All `.env` files are encrypted using your ssh key and - 🔐 **Encrypted Storage**: All `.env` files are encrypted using your ssh key and
[age](https://github.com/FiloSottile/age) encryption. [libsodium](https://github.com/jedisct1/libsodium) encryption.
- 🔄 **Automatic Sync**: Update the database with one command, which can easily - 🔄 **Automatic Sync**: Update the database with one command, which can easily
be run on a cron. be run on a cron.
- 🔍 **Smart Scanning**: Automatically discover and import `.env` files in your - 🔍 **Smart Scanning**: Automatically discover and import `.env` files in your
@@ -37,12 +37,13 @@ repositories.
## Installation ## Installation
### With Go ### With Odin
If you already have `go` installed: If you already have `odin` installed:
```bash ```bash
go install github.com/sbrow/envr # You'll need libsodium and sqlite
odin build -o:speed
envr init envr init
``` ```
@@ -104,18 +105,18 @@ The configuration file is created during initialization:
## Backup Options ## Backup Options
`envr` merely gathers your `.env` files in one local place. It is up to you to `envr` merely gathers your `.env` files in one local place. It is up to you to
back up the database (found at `~/.envr/data.age`) to a *secure* and *remote* back up the database (found at `~/.envr/data.envr`) to a *secure* and *remote*
location. location.
### Git ### Git
`envr` preserves inodes when updating the database, so you can safely hardlink `envr` preserves inodes when updating the database, so you can safely hardlink
`~/.envr/data.age` into your [GNU Stow](https://www.gnu.org/software/stow/), `~/.envr/data.envr` into your [GNU Stow](https://www.gnu.org/software/stow/),
[Home Manager](https://github.com/nix-community/home-manager), or [Home Manager](https://github.com/nix-community/home-manager), or
[NixOS](https://nixos.wiki/wiki/flakes) repository. [NixOS](https://nixos.wiki/wiki/flakes) repository.
> [!CAUTION] > [!CAUTION]
> For **maximum security**, only save your `data.age` file to a local > For **maximum security**, only save your `data.envr` file to a local
(i.e. non-cloud) git server that **you personally control**. (i.e. non-cloud) git server that **you personally control**.
> >
> I take no responsibility if you push all your secrets to a public GitHub repo. > I take no responsibility if you push all your secrets to a public GitHub repo.