Howto/pages/02.tutorials/04.Chat/01.Webchat/docs.en.md

8.2 KiB

title published visible indexed updated taxonomy page-toc
Chat: Webchat true true true
last_modified app app_version
September 2021 Converse.js 7.0.3dev
category tags
docs
chat
xmpp
converse
active
true

Converse.js is a free and open-source XMPP chat client that runs in the web browser. You can use your Disroot account to connect to XMPP through webchat.disroot.org.

Connecting

Open a web browser and go to webchat.disroot.org

  1. XMPP Address: Enter your Disroot email address
  2. Password: Type your Disroot password
  3. This is a trusted device: Uncheck this box if you're not on your own computer.

User Interface

Once you have logged in, you will see something like this:

  1. Your personal details

  • a. Settings: here you can check the Converse.js version and enter ad-hoc commands
  • b. Logout button
  • c. Your online status: you can select a status and/or write your own personal status message
  1. Groupchats: The list of chat rooms you're logged in
  2. Bookmarks: Your bookmarked rooms
  3. Contacts: Your XMPP contacts
  4. Chat room: The current room
    • a. From the three-lines menu at the right you can unbookmark the room, view its general details, invite someone to join, hide the topic or leave the chat.

  1. The current ongoing chat
  2. Participants: The participants of the room
  3. The message box

Rooms

You can participate in group discussions, also called "groupchats" or "rooms".

Entering a room

To join or create a room, just click on the + button, in the Groupchat section.

  1. Groupchat address: Here goes the address of the room you want to join. It can be the address of any room from any XMPP server that federates.
    For example: if you want to join a room hosted on the Disroot server, you will need to type chat.disroot.org.

  2. Nickname: It is the alias you want to use. It doesn't have to be your real Disroot username. You can have different usernames for each room you're in if you want.

  3. Join: Click here to join the room.

Sending messages

To send a message, just type it in the message box and then press Enter.

There are four buttons in the message box:

To insert emojis To write your message as a spoiler
To share a file (it can be any type of file, the maximum size is 10MB) To enable/disable OMEMO encryption

!! TIP: To insert a line break in a message, press Shift + Enter.

Mentions

You can "mention" people in your message so they get a notification. Start to write the first letters and tap on the tab key of your keyboard to have a suggestion list of nicknames.

Here, we can see the user is actually reading stuff from the Prosody room (blue background) and get a message with its username in the Disroot Howto room.

Editing messages

If you want to correct a message you have sent, mouse over it and a pencil will appear on the right. Click on it, correct your message and send it again.

Leaving a room

To leave a room, simply click the arrow icon on the top-right corner of the room page.

You can also mouse over the room's name in the Groupchats list at the left pannel and click on the arrow icon that appears there (3rd icon).

Bookmarking a room

You can bookmark rooms in order to join them in later easily and to keep them from one client to another.

To do so, simply click on the flag icon on the top-right corner of the room page.

You can also mouse over the room's name in the Groupchats list at the left pannel and click on the flag icon that appears there (1st icon).

You can find your bookmarked rooms in the left menu.

Room details

If you want to get more information about the room, just click on the "i" icon on the top-right corner of the room page.

Finding a public room

You can search for public rooms (and only for public ones):

  1. Click on this button to open the Search window.
  2. Enter the address of the server you want to search public rooms on. For example, could be chat.disroot.org
  3. Click on "Show groupchats"
  4. You'll then get a list of public rooms. Just click on the one you want to join.

Creating a room

The process is quite similar to enter an existing room.

  1. Click on this button to join or create a room.
  2. Groupchat address: Enter the address of the room you want to create. It only can be a room on Disroot XMPP server. For example, something like mytestroom@chat.disroot.org.
  3. Nickname: you're free to enter whatever username you wish, it doesn't have to be your real Disroot username. You can then have differents usernames on each room you're in if you want.
  4. Join the room by clicking here. If the room already exists, then you'll join in if it is public. Otherwise, you'll need to find another room name.

You'll get a message at the top of the room saying that you just succeeded in creating your room:

Here are the default features of your room when you first create it:

As you've created the room, you're the owner and it's admin. So you can change those features as you want. Click on the tool icon on the top-right corner of the room page.

You'll then get this page:

Direct chat: 1 to 1 conversation

You can also chat with someone in private, in a 1:1 discussion with only the two of you participating.

Adding a contact

First you'll need to add a contact before you can talk to the user.

  1. Click on this button to add a contact.
  2. XMPP Address: XMPP_address_of_your_Contact. It can be any XMPP server address, as long as it federates.
  3. Optional nickname: it can be anything you want.
  4. Add: click on the button once you're done.

The contact will be informed that you have added him/her to your Contacts list. Until the user approves it, this contact can be found in your pending list:

Talking to a contact

Once the contact has been added, you can simply click on its name in the Contacts list to start a private conversation.

Removing a contact

To remove a contact from you Contacts list, click on the trash bin icon next to the user name.

Contact details

To have more information about your contact, click on the ID card icon on the top-right corner of the conversation page.

Encrypting a conversation

If you want your conversation to be really secure, make sure that OMEMO is activated. To do so, check the lock icon. If the lock looks open, then the conversation is not enrypted. {.inline}
If the chat is encrypted then it should look like this: {.inline}

Personal details

Changing name, avatar, etc.

To change your personal details, click on your avatar on the top-left corner.
You can add the following information:

Whenever you want to change it, just click on your avatar and you'll be able to do it.

Changing status

You can change your status by clicking on the pencil next to your actual status:

Logging out

To log out from webchat.disroot.org, just click on the arrow icon next to your username, on the top-left corner.

Converse.js

To know more about the software used, check converse.js website