Skip to content

Commit 4ec1d07

Browse files
authored
Merge pull request #30 from junhsonjb/jjb-update-readme-linux-install
add linux install instructions to README
2 parents 98ccb6e + 29fe368 commit 4ec1d07

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ You can install `dotsec` using one of the following methods:
1717
- [build from source](#build-from-source)
1818
- [install via `crates.io`](#install-via-cratesio)
1919
- [install via homebrew](#install-via-homebrew)
20+
- [install via script (Linux Only)](#install-via-script)
2021

2122
🥅 Short-term goal: Publish on more package managers!
2223

@@ -44,14 +45,25 @@ brew tap junhsonjb/dotsec
4445
brew install dotsec
4546
```
4647

48+
### Install via script
49+
Use `curl` to download the installation script and execute it with `sh`:
50+
```sh
51+
curl -sSL https://raw.githubusercontent.com/junhsonjb/dotsec/main/distribution/install.sh | sh
52+
```
53+
> This script downloads the latest binary and installs it to /usr/local/bin/ds
54+
55+
It's always recommended to inspect scripts that you download off the internet before running them. You can do so by running the following:
56+
```sh
57+
curl -sSL https://raw.githubusercontent.com/junhsonjb/dotsec/main/distribution/install.sh | less
58+
```
59+
> Alternatively, [download the script directly](./distribution/install.sh)
60+
4761
## 🧠 Heads up
4862
The CLI is in early development (`v0.1.x`) — expect rapid iteration and the occasional breaking change. Feedback welcome!
4963

5064
## 🔐 Security
5165
`dotsec` uses [ChaCha20-Poly1305](https://github.com/RustCrypto/AEADs/tree/master/chacha20poly1305) to encrypt and decrypt secrets. Keys and values are stored locally on the user's machine using [sled](https://github.com/spacejam/sled).
5266

53-
⚠️ Encryption keys are stored at `$XDG_CONFIG_HOME/dotsec/private/dotsec.key` (`$XDG_CONFIG_HOME` resolves to `$HOME/.config` unless otherwise defined). **This file is not encrypted. Please do not publicize this file (on github or elsewhere)!** `dotsec`'s primary goal is to provide a safe place to store your CLI secrets. It is the user's responsibility to safely manage their encryption key.
54-
5567
> ⚠️ **Important: Encryption key is stored in plaintext!**
5668
>
5769
> The encryption key is saved to the following location:

0 commit comments

Comments
 (0)