|
|
|
|
@ -11,14 +11,53 @@ keywords: salt, salty, saltpack, chat, im, instant, messaging, messenger, decent
|
|
|
|
|
and platform for secure communications with a focus on privacy, security
|
|
|
|
|
and being self-hosted.
|
|
|
|
|
|
|
|
|
|
# [Read the full specification](/spec.html)
|
|
|
|
|
## 🎬 Demo
|
|
|
|
|
|
|
|
|
|
[](https://asciinema.org/a/ZfcBdiIEO1XOlPWSCR7WWn2Hc)
|
|
|
|
|
|
|
|
|
|
## 👉 Getting Started
|
|
|
|
|
## 🏃 Quick Start
|
|
|
|
|
|
|
|
|
|
- Install `salty-chat`:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ go install go.mills.io/saltyim/cmd/salty-chat@latest
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- Create and register an account:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ salty-chat register <nick>@mills.io
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Replace `<nick>` with a nickname / alias you'd like.
|
|
|
|
|
|
|
|
|
|
- Start chatting!
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ salty-chat chat prologic@mills.io
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Note:** This quick start installs our reference command-line client
|
|
|
|
|
`salty-chat` and registers an account on the broker running at
|
|
|
|
|
[salty.mills.io](https://salty.mills.io).
|
|
|
|
|
|
|
|
|
|
Please note that your IP address is logged ... " and "For your security and privacy you can setup your own broker. Full documentation..
|
|
|
|
|
|
|
|
|
|
**Security Warning:** Please note that your IP address is logged and that
|
|
|
|
|
[salty.mills.io](https://salty.mills.io) is the personal infrastructure of
|
|
|
|
|
[James Mills](https://prologic.shortcircuit.net.au).
|
|
|
|
|
|
|
|
|
|
For full documentation onw how to setup your own broker, with own domain on
|
|
|
|
|
your own infrastructure (**preferred**), please read on...
|
|
|
|
|
|
|
|
|
|
## 👉 Documentation
|
|
|
|
|
|
|
|
|
|
The following is more details documentation on setting up your Domain Name (DNS)
|
|
|
|
|
records (_optional_) and running our reference broker `saltyd` on your own server
|
|
|
|
|
and configuring our reference client `salty-chat`:
|
|
|
|
|
|
|
|
|
|
1. Make sure you have a Domain Name [Choosing a Registrar](#choosing-a-registrar)
|
|
|
|
|
1. Read the [instructions](instructions.html) and start chatting!
|
|
|
|
|
1. Read the [full instructions](instructions.html) and start chatting!
|
|
|
|
|
|
|
|
|
|
### 🌏 Choosing a Registrar
|
|
|
|
|
|
|
|
|
|
@ -50,6 +89,10 @@ encourage you to setup your own domain and server as Salty IM is designed to
|
|
|
|
|
be decentralised, we realize this is not for everyone. By default Salty IM
|
|
|
|
|
will use publicly available free servers so you don't need to worry about this.
|
|
|
|
|
|
|
|
|
|
## 📕 Specification
|
|
|
|
|
|
|
|
|
|
- [Read the full specification](/spec.html)
|
|
|
|
|
|
|
|
|
|
## 💾 Sources
|
|
|
|
|
|
|
|
|
|
The project is managed by a self-hosted [Gitea](https://gitea.io) instance
|
|
|
|
|
|
