Update frontpage with better quick start and fix some inconsistencties in the spec (#19)

Co-authored-by: James Mills <prologic@shortcircuit.net.au>
Reviewed-on: #19
pull/22/head
James Mills 2 months ago
parent 5ca2e39833
commit e3e19f4ad3
  1. 49
      index.md
  2. 8
      spec.md

@ -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
[![asciicast](https://asciinema.org/a/ZfcBdiIEO1XOlPWSCR7WWn2Hc.svg)](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

@ -8,6 +8,7 @@ keywords: spec, specification, salty, self-hosted, decentralised, secure, privat
| Version | Last Modified / Changelog |
| --------| ------------------------- |
| v1.5 | [2022-10-14](#2022-10-14)
| v1.4 | [2022-03-31](#2022-03-31) |
| v1.3 | [2022-03-22](#2022-03-22) |
| v1.2 | [2022-03-19](#2022-03-19) |
@ -80,7 +81,7 @@ A User must publish their Public Key along with an Endpoint for which to receive
Before requesting the well-known url, the client should do a SRV lookup for `_salty._tcp.domain.tld`:
```sh
$ dig +short SRV _salty.domain.tld
$ dig +short SRV _salty._tcp.domain.tld
0 0 443 other.domain.tld
```
@ -166,7 +167,7 @@ This contains the following JSON document:
Example: `xuu@sour.is` has a SRV redirection
```#!sh
$ dig +short SRV _salty.sour.is.
$ dig +short SRV _salty._tcp.sour.is.
0 0 443 via.sour.is.
$ curl https://via.sour.is/.well-known/salty/e4fd5f1cde5d456803d9b0923f59d3e209afc0c67bb111af77dc8006c9f393de.json
{
@ -246,6 +247,9 @@ A Client shall verify the Sender once the message has been decrypted and before
## Changes
### 2022-10-14
- Fix inconsistenct SRV examples
### 2022-03-31
- Clarify SRV usage
- Clarify CORS recommendation

Loading…
Cancel
Save