From 64311a05121961b763e5c7898ea1e8e59678a933 Mon Sep 17 00:00:00 2001 From: hwipl <33433250+hwipl@users.noreply.github.com> Date: Wed, 21 Oct 2020 17:18:58 +0200 Subject: [PATCH] add more account creation info to doc/setup.md Signed-off-by: hwipl <33433250+hwipl@users.noreply.github.com> --- doc/setup.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/doc/setup.md b/doc/setup.md index 156f19e..09b9057 100644 --- a/doc/setup.md +++ b/doc/setup.md @@ -96,7 +96,7 @@ to your backends. You can do this from nuqql with the following steps: * Start nuqql. * Enter the conversation with the backend by pressing the `ENTER` key - on the entry in the Conversation List (`{backend} purpled` or `{backend} + on the entry in the Conversation List (e.g.,`{backend} purpled` or `{backend} slixmppd`). * Add your accounts (note: send the following commands the backend with the `CTRL-X` key combination): @@ -107,6 +107,60 @@ to your backends. You can do this from nuqql with the following steps: example, with this command: `account 0 send user_name@server.com`. Note: `0` is the account ID as shown with `account list`. +The details are backend and chat network/protocol specific. See below for more +information about XMPP/Jabber, Matrix and Mattermost accounts. + +### XMPP/Jabber accounts + +You can add a XMPP/Jabber account with the following command: + +``` +account add xmpp +``` + +The format of xmpp accounts in nuqql-slixmppd is `@`, +e.g., `dummy_user@jabber.org` + +Example: + +``` +account add xmpp user@jabber-server.com users_password +``` + +### Matrix accounts + +You can add a Matrix account with the following command: + +``` +account add matrix +``` + +The format of matrix accounts in nuqql-matrixd is `@`, +e.g., `dummy_user@matrix.org`. + +Example: + +``` +account add matrix dummy_user@matrix.org users_password +``` + +### Mattermost accounts + +You can add a Mattermost account with the following command: + +``` +account add mattermost +``` + +The format of mattermost accounts in nuqql-mattermostd is +`@`, e.g., `dummy_user@yourserver.org:8065`. + +Example: + +``` +account add mattermost dummy_user@yourserver.org:8065 users_password +``` + ## Hacky stuff/additional tools If certain keys do not work, `nuqql-keys` is a tool that might help you to