6
1
mirror of https://git.mills.io/saltyim/saltyim.git synced 2024-06-16 03:48:24 +00:00
saltyim is the Go library and reference client and broker implementation for Salty IM it contains a command-line client (cli), a terminal user interface (tui), builtin server/broker and a Mobile / Desktop App PWA (progressive web app)
Go to file
xuu d1d33e45c6 feat: hax for great justice (#14)
- Dont send message on empty
- inbox flag to override $USER
- Filter messages to only chat with partner.

NOTE: might be better to parse the message in loop to handle events outside the formatting code.

NOTE NOTE: i think we might need to revisit read recipts.. maybe including user@domain?

Co-authored-by: Jon Lundy <jon@xuu.cc>
Reviewed-on: https://git.mills.io/prologic/saltyim/pulls/14
Co-authored-by: xuu <xuu@noreply@mills.io>
Co-committed-by: xuu <xuu@noreply@mills.io>
2022-03-19 21:33:03 +00:00
.chglog Add chglog config 2022-03-20 00:49:56 +10:00
cmd/salty-chat feat: hax for great justice (#14) 2022-03-19 21:33:03 +00:00
scripts fix: some fixes to display artifacts (#13) 2022-03-19 21:32:08 +00:00
tools Add lookup command (#4) 2022-03-18 14:48:59 +00:00
.gitignore Ooops 2022-03-20 00:50:43 +10:00
.goreleaser.yml Publish releases straight away 2022-03-20 00:46:54 +10:00
CHANGELOG.md Update CHANGELOG for 0.0.4 2022-03-20 02:38:20 +10:00
config.go Add make-user command (#9) 2022-03-19 11:42:36 +00:00
go.mod Re-add beeep desktop notifications 2022-03-20 00:46:21 +10:00
go.sum Re-add beeep desktop notifications 2022-03-20 00:46:21 +10:00
identity.go feat: hax for great justice (#14) 2022-03-19 21:33:03 +00:00
LICENSE Add lookup command (#4) 2022-03-18 14:48:59 +00:00
lookup.go feat: hax for great justice (#14) 2022-03-19 21:33:03 +00:00
Makefile Add lookup command (#4) 2022-03-18 14:48:59 +00:00
preflight.sh feat: hax for great justice (#14) 2022-03-19 21:33:03 +00:00
README.md Update 'README.md' 2022-03-19 13:05:36 +00:00
readmsgs.go Re-add beeep desktop notifications 2022-03-20 00:46:21 +10:00
sendmsg.go Refactor lookup and send and bild a Request utility function 2022-03-19 11:24:07 +10:00
utils.go Don't double log errors in Request() 2022-03-20 01:24:21 +10:00
version.go Add lookup command (#4) 2022-03-18 14:48:59 +00:00

Salty IM

Quick Start

$ go install go.mills.io/saltyim/cmd/salty-chat@latest
$ salty-chat make-user user@domain
$ salty-chat chat prologic@mills.io

NOTE:

As of 19th March 2022 15:42 AEST some of the below documentation is now out-of-date and will be updated soon as well as the landing page salty.im


A rudimentary terminal / command-line based chat system using the salty command-line tool for encrypting and decrypting messages using the saltpack message format and using msgbus as transport.

Requirements

  • You need a POSIX Shell, e.g: /bin/sh
    • You also need jq installed (the script uses this to parse the JSON from Discovery requests)
  • msgbus
  • salty

If you have Go installed:

$ 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

Quick Start

export MSGBUS_URI=https://msgbus.<yourdomain>
$ ./salty-chat read &
$ ./salty-chat chat prologic@mills.io

NB: You need to ensure you have a valid msgbus Endpoint for salt-chat to work. See Endpoint for details.

Setup

SKip this section if you ran salty-chat make-user

Keys

To generate your Private / Public keys:

$ salty-keygen -o $HOME/.config/salty/$USER.key

Setup an environment variable in your shell to point SALTY_IDENTITY to $HOME/.config/salty/$USER.key. For example:

export SALTY_IDENTITY="$HOME/.config/salty/$USER.key"

Endpoint

First you need to setup msgbus somewhere, see that project for details on how to set this up. Or you can just use the instance I run at https://msgbus.mills.io/ (just please don't abuse it!)

Point an environment variable called MSGBUS_URI to your msgbus instance.

Example:

export MSGBUS_URI=https://msgbus.mills.io

NB: You are welcome to use my (James Mills) msgbus instance above but please don't abuse it!

Discovery

Create a JSON file called <user>.json and place it at the root of your domain on a path like /.well-known/salty/user.json. The conents of which are:

{
  "endpoint": "https://msgbus.mills.io",
  "topic": "prologic",
  "key": "kex1ekt5cru4vs42wnaxppkjn5pexmt2w6uxx9z2mz0fqeuc80e0g9gsggs8ah"
}

You can see an example of prologic@mills.io

Usage

Start a Chat

$ ./salty-chat chat prologic@mills.io
>

Sending a Message

$ ./salty-chat send prologic@mills.io Test
2022/03/17 01:46:14 Reading message from stdin...

Receiving your Messages

$ ./salty-chat read
INFO[0000] successfully connected to wss://msgbus.mills.io/prologic
# signed by: kex1ekt5cru4vs42wnaxppkjn5pexmt2w6uxx9z2mz0fqeuc80e0g9gsggs8ah
[2022-03-17T01:23+10:00] <prologic> Test
# signed by: kex1ekt5cru4vs42wnaxppkjn5pexmt2w6uxx9z2mz0fqeuc80e0g9gsggs8ah
[2022-03-17T01:46+10:00] <prologic> Test

License

salty-msgbus-chat is licensed under the terms of the WTFPL license.