diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 135 |
1 files changed, 97 insertions, 38 deletions
@@ -60,7 +60,8 @@ Add public peer: [1] PEER UPD discovery1.erebosprotocol.net [37.221.243.57 29665] ``` -Select the peer and send it a message, the public server just responds with automatic echo message: +Select the peer and send it a message, the public server just responds with +automatic echo message: ``` > /1 discovery1.erebosprotocol.net> hello @@ -68,30 +69,83 @@ discovery1.erebosprotocol.net> hello [18:55] discovery1.erebosprotocol.net: Echo: hello ``` +List chatrooms known to the peers: +``` +> /chatrooms +[1] Test chatroom +[2] Second test chatroom +``` + +Enter a chatroom and send a message there: +``` +> /1 +Test chatroom> Hi +Test chatroom [19:03] Some Name: Hi +``` + ### Messaging `/peers` -List peers with direct network connection. Peers are discovered automatically -on local network or can be manually added. +: List peers with direct network connection. Peers are discovered automatically + on local network or can be manually added. `/contacts` -List known contacts (see below). +: List known contacts (see below). `/conversations` -List started conversations with contacts or other peers. +: List started conversations with contacts or other peers. `/<number>` -Select conversation, contact or peer `<number>` based on the last -`/conversations`, `/contacts` or `/peers` output list. +: Select conversation, contact or peer `<number>` based on the last + `/conversations`, `/contacts` or `/peers` output list. `<message>` -Send `<message>` to selected conversation. +: Send `<message>` to selected conversation. + +`/history [<number>]` +: Show message history of the selected conversation, or the one identified by + `<number>` if given. + +`/details [<number>]` +: Show information about the selected conversations, contact or peer; or the + one identified by `<number>` if given. + +### Chatrooms + +Currently only public unmoderated chatrooms are supported, which means that any +network peer is allowed to read and post to the chatroom. Individual messages +are signed, so message author can not be forged. + +`/chatrooms` +: List known chatrooms. + +`/chatroom-create-public [<name>]` +: Create public unmoderated chatroom. Room name can be passed as command + argument or entered interactively. + +`/members` +: List members of the chatroom – usesers who sent any message or joined via the +`join` command. + +`/join` +: Join chatroom without sending text message. + +`/join-as <name>` +: Join chatroom using a new identity with a name `<name>`. This new identity is + unrelated to the main one, and will be used for any future messages sent to + this chatroom. -`/history` -Show message history of the selected conversation. +`/leave` +: Leave the chatroom. User will no longer be listed as a member and erebos tool + will no longer collect message of this chatroom. -`/details` -Show information about the selected conversations, contact or peer. +`/delete [<number>]` +: Delete the chatroom (currently selected one, or the one identified by + `<number>`); this action is only synchronized with devices belonging to the + current user and does not affect the chatroom state for others. Due to the + storage design, the chatroom data will not be purged from the local state + history, but the chatroom will no longer be listed as available and no futher + updates for this chatroom will be collected or shared with other peers. ### Add contacts @@ -101,21 +155,22 @@ contacts to contact list (similar to bluetooth device pairing). Before adding new contact, list peers using `/peers` command and select one with `/<number>`. `/contacts` -List already added contacts. +: List already added contacts. `/contact-add` -Add selected peer as contact. Six-digit verification code will be computed -based on peer keys, which will be displayed on both devices and needs to be -checked that both numbers are same. After that it needs to be confirmed using -`/contact-accept` to finish the process. +: Add selected peer as contact. Six-digit verification code will be computed + based on peer keys, which will be displayed on both devices and needs to be + checked that both numbers are same. After that it needs to be confirmed using + `/contact-accept` to finish the process. `/contact-accept` -Confirm that displayed verification codes are same on both devices and add the -selected peer as contact. The side, which did not initiate the contact adding -process, needs to select the corresponding peer with `/<number>` command first. +: Confirm that displayed verification codes are same on both devices and add + the selected peer as contact. The side, which did not initiate the contact + adding process, needs to select the corresponding peer with `/<number>` + command first. `/contact-reject` -Reject contact request or verification code of selected peer. +: Reject contact request or verification code of selected peer. ### Attach other devices @@ -134,44 +189,48 @@ Before attaching device, list peers using `/peers` command and select the target device with `/<number>`. `/attach` -Attach current device to the selected peer. After the process completes the -owner of the selected peer will become owner of this device as well. Six-digit -verification code will be displayed on both devices and the user needs to check -that both are the same before confirmation using the `/attach-accept` command. +: Attach current device to the selected peer. After the process completes the + owner of the selected peer will become owner of this device as well. + Six-digit verification code will be displayed on both devices and the user + needs to check that both are the same before confirmation using the + `/attach-accept` command. `/attach-accept` -Confirm that displayed verification codes are same on both devices and complete -the attachment process (or wait for the confirmation on the peer device). The -side, which did not initiate the attachment process, needs to select the -corresponding peer with `/<number>` command first. +: Confirm that displayed verification codes are same on both devices and + complete the attachment process (or wait for the confirmation on the peer + device). The side, which did not initiate the attachment process, needs to + select the corresponding peer with `/<number>` command first. `/attach-reject` -Reject device attachment request or verification code of selected peer. +: Reject device attachment request or verification code of selected peer. ### Other `/peer-add <host> [<port>]` -Manually add network peer with given hostname or IP address. +: Manually add network peer with given hostname or IP address. `/peer-add-public` -Add known public network peer(s). +: Add known public network peer(s). `/peer-drop` -Drop the currently selected peer. Afterwards, the connection can be -re-established by either side. +: Drop the currently selected peer. Afterwards, the connection can be + re-established by either side. `/update-identity` -Interactively update current identity information +: Interactively update current identity information `/quit` -Quit the erebos tool. +: Quit the erebos tool. Storage ------- -Data are by default stored within `.erebos` subdirectory of the current working -directory. This can be overriden by `EREBOS_DIR` environment variable. +Data are by default stored under `XDG_DATA_HOME`, typically +`$HOME/.local/share/erebos`, unless there is an erebos storage already +in `.erebos` subdirectory of the current working directory, in which case the +latter one in used instead. This can be overriden by `EREBOS_DIR` environment +variable. Private keys are currently stored in plaintext under the `keys` subdirectory of the erebos directory. |