Update index page and move instructions to its own page (#16)

Signed-off-by: Aoi K <admin@kyoko-project.wer.ee>
Co-authored-by: Aoi K <admin@kyoko-project.wer.ee>
Reviewed-on: #16
Reviewed-by: James Mills <james@mills.io>
Co-authored-by: Aoi Koizumi (古泉 あおい) <novaburst@noreply@mills.io>
Co-committed-by: Aoi Koizumi (古泉 あおい) <novaburst@noreply@mills.io>
pull/18/head
Aoi Koizumi (古泉 あおい) 3 weeks ago committed by James Mills
parent b53d2bbe85
commit fe1d7d7121
  1. 38
      index.md
  2. 40
      instructions.md

@ -18,8 +18,7 @@ and being self-hosted.
## 👉 Getting Started
1. Make sure you have a Domain Name [Choosing a Registrar](#choosing-a-registrar)
1. Install a Salty IM client for your device. [Installing Salty](#installing-salty)
1. Setup and start chatting! [Setup](#setup)
1. Read the [instructions](instructions.html) and start chatting!
### 🌏 Choosing a Registrar
@ -41,41 +40,6 @@ As Salty IM is decentralised this is an important step. If you cannot for some
reason obtain a domain name and run a small web server, there are other options
(see below).
### 💾 Installing Salty
To install Salty Chat simply run the following in your Terminal:
```#!sh
$ go install go.mills.io/saltyim/cmd/salty-chat@latest
```
**Note:** Currently you will need to have [Go](https://golang.org) installed
as we do not yet currently release any packages for download yet. You may also
need to set `GOPATH` and add `$GOPATH/bin` to your `$PATH`. Example:
```#!sh
export GOPATH="$HOME/go"
export PATH="$GOPATH/bin:$PATH"
```
### ⚙ Setup
Once you have a Domain, a Web Server and have Salty Chat installed, run:
```#!sh
$ salty-chat make-user user@domain
```
And follow the instructions.
You're all set! Happy chatting! 🤗
Say hi 👋
```#!sh
$ salty-chat send prologic@mills.io "Hey! 👋 This is really cool! 😎"
```
### ⁉ Help! What?!
Okay if you don't understand anything about Domains and Web Servers don't worry!

@ -0,0 +1,40 @@
---
title: Instructions
---
Note: Currently you will need the [Go](https://go.dev) 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"
```
3. 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
```
2. Install `jq` either from source or from your distribution's or OS's package manager.
3. Fetch the [salty-chat.sh](https://git.mills.io/saltyim/saltyim/src/branch/master/bin/salty-chat.sh) script and place it somewhere accessible into your `$PATH` with the proper execution bit set (mode 0755)
4. 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
This part is covered in the [Deployment guide](https://git.mills.io/saltyim/saltyim/src/branch/master/docs/Deployment.md)
Loading…
Cancel
Save