Landing page for salty.im a open specification for a new Saltpack based e2e encrypted messaging protocol and platform for secure communications with a focus on privacy, security and being self-hosted. https://salty.im/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
salty.im/instructions.md

1.6 KiB

title
Instructions

Note: Currently you will need the Go toolchain installed as we don't publish binaries yet.

Client-side

  1. Run go install go.mills.io/saltyim/cmd/salty-chat@latest
  2. Add $GOPATH/bin to your $PATH with:
# This is most likely already set by the toolchain itself
export $GOPATH="$HOME/go"

# This is what you should actually do
export PATH="$PATH:$GOPATH/bin"
  1. Run salty-chat make-user <username> <broker-url> or if a saltyd endpoint exists, then use salty-chat register <username>@<host> <broker-url> instead

or

  1. Install msgbus, salty and salty-keygen with:
go install git.mills.io/prologic/msgbus/cmd/msgbus@latest
go install go.mills.io/salty/cmd/salty@latest
go install go.mills.io/salty/cmd/salty-keygen@latest
  1. Install jq either from source or from your distribution's or OS's package manager.

  2. Fetch the salty-chat.sh script and place it somewhere accessible into your $PATH with the proper execution bit set (mode 0755)

  3. Run salty-chat.sh make-user <username>@<host> or if a saltyd endpoint exists, then use salty-chat.sh register <username>@<host> instead.

Server-side

Deployment of a saltyd broker may vary between platforms, the following being listed below:

How to request SSL/TLS certificates and such won't be covered by this guide.