318c3275b5
Co-authored-by: Jon Lundy <jon@xuu.cc> Reviewed-on: https://git.mills.io/saltyim/saltyim/pulls/175 Reviewed-by: James Mills <james@mills.io> Co-authored-by: xuu <xuu@noreply@mills.io> Co-committed-by: xuu <xuu@noreply@mills.io> |
||
|---|---|---|
| .chglog | ||
| .dockerfiles | ||
| bin | ||
| certs | ||
| cmd | ||
| data | ||
| docs | ||
| hooks | ||
| internal | ||
| tools | ||
| .drone.yml | ||
| .gitattributes | ||
| .gitignore | ||
| .goreleaser.yml | ||
| Caddyfile | ||
| CHANGELOG.md | ||
| client_test.go | ||
| client.go | ||
| Corefile | ||
| db.home.arpa | ||
| Dockerfile | ||
| example-config.yml | ||
| format_test.go | ||
| format.go | ||
| go.mod | ||
| go.sum | ||
| identity_test.go | ||
| identity.go | ||
| LICENSE | ||
| log | ||
| lookup_test.go | ||
| lookup.go | ||
| Makefile | ||
| OLDREADME.md | ||
| options.go | ||
| preflight.sh | ||
| README.md | ||
| resolv.go | ||
| Roadmap.md | ||
| send.go | ||
| service.go | ||
| state.go | ||
| types.go | ||
| utils_test.go | ||
| utils.go | ||
| version.go | ||
Salty IM -- secure, easy, self-hosted messaging
Salty IM is a secure, decentrlaised and easy self-hosted instant messaging alternative. Salty IM is fully encrypted using the salty Go library utilising the Saltypack messaging format and parts of keys.pub implemtnation for its cryptography. Encryption, Decryption and Signing of messages is performed with public key cryptography using the Ed25519 algoritms.
For more information on how the protocol works, please refer to the Specification.
This repository also contains a reference client (written in Go), a reference
broker (server) as well as a Terminal TUI (TUI) client called salty-chat and
command-line tools:
saltyd-- Reference broker (server)salty-chat-- Command-line tools and Terminal UI (TUI)- saltyim -- Reference client (Go library)
Quick Start CLI
$ go install go.mills.io/saltyim/cmd/salty-chat@latest
$ salty-chat make-user user@domain
# Follow the insturctions
$ salty-chat chat prologic@mills.io
Alternatively follow the full documentation below to setup your own Salty broker and your domain name.
Quick Start (DEV)
Documentation
See also the Old Readme for how this implementation started out as a simple shell script which you can still find at salty-chat.sh.
Roadmap
Please refer to the Roadmap document.
License
saltyd and salty-chat are licensed under the terms of the MIT
license.