Mirrors/prologic-saltyim
6
1
Fork 0
mirror of https://git.mills.io/saltyim/saltyim.git synced 2024-06-26 00:38:22 +00:00
Code Issues Projects Releases Wiki Activity

Update README with more docs

Browse Source
This commit is contained in:
James Mills 2022-03-17 01:54:20 +10:00
parent 8e7688b8ae
commit 5a06155fdf
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -15,11 +15,28 @@ If you have [Go](https://golang.org) installed:
```#!sh
$ go install git.mills.io/prologic/msgbus/cmd/msgbus@latest
$ go install go.mills.io/salty@latest
$ go install go.mills.io/salty/cmd/salty@latest
$ go install go.mills.io/salty/cmd/salty-keygen@latest
```
## Setup
### Keys
To generate your Private / Public keys:
```#!sh
$ mkdir -p $HOME/.salty
$ salty-keygen -o $HOME/.salty/$USER.key
```
Setup an environment variable in your shell to point `SALTY_IDENTITY`
to `$HOME/.salty/$USER.key`. For example:
```#!sh
export SALTY_IDENTITY="$HOME/.salty/$USER.key"
```
### Endpoint
First you need to setup [msgbus](https://git.mills.io/prologic/msgbus)