add Talk documentation
Signed-off-by: Jos Poortvliet <jospoortvliet@gmail.com>
@@ -12,6 +12,7 @@ Table of contents
|
||||
webinterface
|
||||
files/index
|
||||
pim/index
|
||||
talk/index
|
||||
userpreferences
|
||||
universal_access
|
||||
user_2fa
|
||||
|
||||
74
user_manual/talk/advanced_features.rst
Normal file
@@ -0,0 +1,74 @@
|
||||
Advanced Talk features
|
||||
======================
|
||||
|
||||
Nextcloud Talk has a number of advanced features users might find useful.
|
||||
|
||||
Matterbridge
|
||||
------------
|
||||
|
||||
Matterbridge integration in Nextcloud Talk makes it possible to create 'bridges' between Talk conversations and conversations on other chat services like MS Teams, Discord, Matrix and others. You can find a list of supported protocols `on the Matterbridge github page. <https://github.com/42wim/matterbridge#features>`_
|
||||
|
||||
A moderator can add a Matterbridge connection in the chat conversation settings.
|
||||
|
||||
.. image:: images/matterbridge-settings.png
|
||||
|
||||
Each of the bridges has its own need in terms of configuration. Information for most is available on the Matterbridge wiki and can be accessed behind ``more information`` menu in the ... menu. You can also `access the wiki directly. <https://github.com/42wim/matterbridge/wiki>`_
|
||||
|
||||
Lobby
|
||||
-----
|
||||
|
||||
The lobby feature allows you to show guests a waiting screen until the call starts. This is ideal for webinars with external participants, for example.
|
||||
|
||||
.. image:: images/lobby-in-talk.png
|
||||
|
||||
You can choose to let the participants join the call at a specific time, or when you dismiss the lobby manually.
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
Nextcloud allows users to execute actions using commands. A command typically looks like
|
||||
|
||||
``/wiki airplanes``
|
||||
|
||||
Administrators can configure, enable and disable commands. Users can use the ``help`` command to find out what commands are available.
|
||||
|
||||
``/help``
|
||||
|
||||
.. image:: images/command-help.png
|
||||
|
||||
Find more information in the `admin documentation for Talk. <https://nextcloud-talk.readthedocs.io/en/stable/commands/>`_
|
||||
|
||||
Talk from Files
|
||||
---------------
|
||||
|
||||
In the Files app, you can chat about files in the sidebar, and even have a call while editing it. You first have to join the chat.
|
||||
|
||||
.. image:: images/join-chat.png
|
||||
|
||||
.. image:: images/sidebar-chat.png
|
||||
|
||||
You can then chat or have a call with other participants, even when you start editing the file.
|
||||
|
||||
.. image:: images/text-and-talk.png
|
||||
|
||||
In Talk, a conversation will be created for the file. You can chat from there, or go back to the file using the ``...`` menu in the top-right.
|
||||
|
||||
.. image:: images/file-room.png
|
||||
|
||||
Create tasks from chat or share tasks in chat
|
||||
---------------------------------------------
|
||||
|
||||
If Deck is installed, you can use the ``...`` menu of a chat message and turn the message into a Deck task.
|
||||
|
||||
.. image:: images/chat-message-menu.png
|
||||
|
||||
.. image:: images/deck-talk-create-card-menu.png
|
||||
|
||||
.. image:: images/deck-talk-create-card-dialog.png
|
||||
|
||||
From within Deck, you can share tasks into chat conversations.
|
||||
|
||||
.. image:: images/deck-talk-share-card-to-chat-menu.png
|
||||
|
||||
.. image:: images/deck-talk-share-card-to-chat-in-talk.png
|
||||
|
||||
BIN
user_manual/talk/images/add-participants.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
user_manual/talk/images/call-menu.png
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
user_manual/talk/images/call-settings.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
BIN
user_manual/talk/images/change-name.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
user_manual/talk/images/chat-message-menu.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
user_manual/talk/images/chat-room-settings.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
BIN
user_manual/talk/images/chat-with-one-user.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
user_manual/talk/images/command-help.png
Normal file
|
After Width: | Height: | Size: 104 KiB |
BIN
user_manual/talk/images/creating-group-room.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
user_manual/talk/images/deck-talk-create-card-dialog.png
Normal file
|
After Width: | Height: | Size: 230 KiB |
BIN
user_manual/talk/images/deck-talk-create-card-menu.png
Normal file
|
After Width: | Height: | Size: 49 KiB |
BIN
user_manual/talk/images/deck-talk-share-card-to-chat-in-talk.png
Normal file
|
After Width: | Height: | Size: 239 KiB |
BIN
user_manual/talk/images/deck-talk-share-card-to-chat-menu.png
Normal file
|
After Width: | Height: | Size: 72 KiB |
BIN
user_manual/talk/images/drag-and-drop.png
Normal file
|
After Width: | Height: | Size: 138 KiB |
BIN
user_manual/talk/images/editing-document-in-chat-room.png
Normal file
|
After Width: | Height: | Size: 267 KiB |
BIN
user_manual/talk/images/emoji-picker.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
BIN
user_manual/talk/images/file-room.png
Normal file
|
After Width: | Height: | Size: 37 KiB |
BIN
user_manual/talk/images/guest-room-menu.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
user_manual/talk/images/guest-settings.png
Normal file
|
After Width: | Height: | Size: 117 KiB |
BIN
user_manual/talk/images/guest-view.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
user_manual/talk/images/join-call.png
Normal file
|
After Width: | Height: | Size: 148 KiB |
BIN
user_manual/talk/images/join-chat.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
user_manual/talk/images/lobby-in-talk.png
Normal file
|
After Width: | Height: | Size: 6.0 KiB |
BIN
user_manual/talk/images/matterbridge-settings.png
Normal file
|
After Width: | Height: | Size: 36 KiB |
BIN
user_manual/talk/images/new-room.png
Normal file
|
After Width: | Height: | Size: 115 KiB |
BIN
user_manual/talk/images/open-settings.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
user_manual/talk/images/participant-menu.png
Normal file
|
After Width: | Height: | Size: 13 KiB |
BIN
user_manual/talk/images/reply.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
user_manual/talk/images/share-files-in-chat-selection.png
Normal file
|
After Width: | Height: | Size: 26 KiB |
BIN
user_manual/talk/images/share-files-in-chat.png
Normal file
|
After Width: | Height: | Size: 9.8 KiB |
BIN
user_manual/talk/images/sidebar-chat.png
Normal file
|
After Width: | Height: | Size: 63 KiB |
BIN
user_manual/talk/images/talk-commands.png
Normal file
|
After Width: | Height: | Size: 138 KiB |
BIN
user_manual/talk/images/talk-grid-view.png
Normal file
|
After Width: | Height: | Size: 993 KiB |
BIN
user_manual/talk/images/talk-promoted-view.png
Normal file
|
After Width: | Height: | Size: 1.0 MiB |
BIN
user_manual/talk/images/talk-settings.png
Normal file
|
After Width: | Height: | Size: 307 KiB |
BIN
user_manual/talk/images/talk-upload-files.png
Normal file
|
After Width: | Height: | Size: 131 KiB |
BIN
user_manual/talk/images/text-and-talk.png
Normal file
|
After Width: | Height: | Size: 368 KiB |
17
user_manual/talk/index.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
====
|
||||
Talk
|
||||
====
|
||||
|
||||
Nextcloud Talk offers audio/video and text chat integrated in Nextcloud. It offers
|
||||
a web interface as well as mobile apps.
|
||||
|
||||
You can find out more about Nextcloud Talk `on our website <https://nextcloud.com/talk/>`_.
|
||||
|
||||
.. image:: images/talk-promoted-view.png
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
talk_basics
|
||||
advanced_features
|
||||
join_a_call_or_chat_as_guest
|
||||
48
user_manual/talk/join_a_call_or_chat_as_guest.rst
Normal file
@@ -0,0 +1,48 @@
|
||||
join a call or chat as guest
|
||||
============================
|
||||
|
||||
Nextcloud Talk offers audio/video and text chat integrated in Nextcloud. It offers
|
||||
a web interface as well as mobile apps.
|
||||
|
||||
You can find out more about Nextcloud Talk `on our website <https://nextcloud.com/talk/>`_.
|
||||
|
||||
Joining a chat
|
||||
--------------
|
||||
|
||||
If you received a link to a chat conversation, you can open this in your browser to join the chat.
|
||||
|
||||
.. image:: images/guest-view.png
|
||||
|
||||
You can change your name using the edit button on the top-right by clicking the ``✏ Edit`` button.
|
||||
|
||||
.. image:: images/change-name.png
|
||||
|
||||
Your camera and microphone settings can be found in the ``⚙ Settings`` menu. There you can also find a list of shortcuts you can use.
|
||||
|
||||
.. image:: images/guest-settings.png
|
||||
|
||||
You can start a call any time with the ``🎥 Start call`` button. Other participants will get notified and can join the call. If somebody else has started a call already, the button will change in a green ``🎥 Join call`` button.
|
||||
|
||||
.. image:: images/join-call.png
|
||||
|
||||
During a call, you can find the Camera and Microphone settings in the ``...`` menu on your video.
|
||||
|
||||
.. image:: images/call-menu.png
|
||||
|
||||
.. image:: images/talk-settings.png
|
||||
|
||||
During a call, you can mute your microphone and disable your video with the buttons on your video on the bottom-right, or using the shortcuts ``m`` to mute audio and ``v`` to disable video. You can also use the space bar to toggle mute. When you are muted, pressing space will unmute you so you can speak until you let go of the space bar. If you are unmuted, pressing space will mute you until you let go.
|
||||
|
||||
You can hide your video (useful during a screen share) with the little arrow just above the video stream. Bring it back with the little arrow again.
|
||||
|
||||
Starting a screen share
|
||||
-----------------------
|
||||
|
||||
You can click the monitor icon on your video stream to share your screen. Depending on your browser, you will get the option to share a monitor, an application window or a single browser tab.
|
||||
|
||||
More settings
|
||||
-------------
|
||||
|
||||
In the conversation menu you can choose to go full-screen. You can also do this by using the ``f`` key on your keyboard. In the conversation settings, you can find notification options and the full conversation description.
|
||||
|
||||
.. image:: images/guest-room-menu.png
|
||||
144
user_manual/talk/talk_basics.rst
Normal file
@@ -0,0 +1,144 @@
|
||||
========================
|
||||
Basics of Nextcloud Talk
|
||||
========================
|
||||
|
||||
Nextcloud Talk lets you chat and have video calls on your own server.
|
||||
|
||||
Chats and calls take place in conversations. You can create any number of conversations. There are two kinds of conversations:
|
||||
|
||||
1. **One-on-one conversations.** This is where you have a private chat or call with another Talk user. You can't add other people to this conversation or share it with a link. You start a direct one-on-one chat by looking for another user in the search bar and then clicking their name.
|
||||
|
||||
|
||||
2. **Group conversations.** Besides the person who created the conversation, a group conversation can have any number of people in it. A group conversation can be shared publicly with a link, so external guest users can join a call. It can also be listed, so other people on your Nextcloud server can join the conversation.
|
||||
|
||||
Creating a chat
|
||||
---------------
|
||||
|
||||
You can create a direct, one-on-one chat by searching for the name of a user, a group or a circle and clicking it. For a single user, a conversation is immediately created and you can start your chat. For a group or circle you get to pick a name and settings before you create the conversation and add the participants.
|
||||
|
||||
.. image:: images/chat-with-one-user.png
|
||||
|
||||
If you want to create a custom group conversation, click the ``plus`` button next to the search field. You can then pick a name for the conversation and select if the conversation should be open to external users and if other users on the server can see and join the conversation.
|
||||
|
||||
.. image:: images/creating-group-room.png
|
||||
|
||||
In the second step, you get to add participants and finalize the creation of the conversation.
|
||||
|
||||
.. image:: images/add-participants.png
|
||||
|
||||
You can cancel the creation of a conversation by clicking outside the white menu area at any time.
|
||||
|
||||
.. image:: images/new-room.png
|
||||
|
||||
|
||||
Sharing files in a chat
|
||||
-----------------------
|
||||
|
||||
You can share files in a chat in 3 ways.
|
||||
|
||||
First, you can simply drag'n'drop them on the chat.
|
||||
|
||||
.. image:: images/drag-and-drop.png
|
||||
|
||||
Second, you can select a file from your Nextcloud Files or a file manager by choosing the little paperclip and selecting where you'd like to pick the file from.
|
||||
|
||||
.. image:: images/share-files-in-chat.png
|
||||
|
||||
.. image:: images/share-files-in-chat-selection.png
|
||||
|
||||
You can add more files until you are done and decide to share the files.
|
||||
|
||||
.. image:: images/talk-upload-files.png
|
||||
|
||||
All users will be able to click the files to view, edit or download them, irrespective of them having a user account. Users with an account will have the file automatically shared with them while external guest users will get them shared as a public link.
|
||||
|
||||
.. image:: images/editing-document-in-chat-room.png
|
||||
|
||||
Inserting emoji
|
||||
---------------
|
||||
|
||||
You can add emoji using the picker on the left of the text input field.
|
||||
|
||||
.. image:: images/emoji-picker.png
|
||||
|
||||
Replying to messages and more
|
||||
-----------------------------
|
||||
|
||||
You can reply to a message using the arrow that appears when you hover a message.
|
||||
|
||||
.. image:: images/reply.png
|
||||
|
||||
In the ``...`` menu you can also choose to reply privately. This will open a one-on-one chat.
|
||||
|
||||
.. image:: images/chat-message-menu.png
|
||||
|
||||
Here you can also create a direct link to the message or mark it unread so you will scroll back there next time you enter the chat. When it is a file, you can view the file in Files.
|
||||
|
||||
Managing a conversation
|
||||
---------------
|
||||
|
||||
You are always moderator in your new conversation. In the participant list on the right you can elevate other participants to moderators using the ``...`` menu to the right of their user name, or remove them from the conversation.
|
||||
|
||||
.. image:: images/participant-menu.png
|
||||
|
||||
Moderators can configure the conversation. Select ``Configuration settings`` from the ``...`` menu of the conversation on the top to access the settings.
|
||||
|
||||
.. image:: images/open-settings.png
|
||||
|
||||
Here you can configure the name, guest access, if the conversation is visible to others on the server and more.
|
||||
|
||||
.. image:: images/chat-room-settings.png
|
||||
|
||||
Starting a call
|
||||
---------------
|
||||
|
||||
When you're in a conversation, you can start a call any time with the ``🎥 Start call`` button. Other participants will get notified and can join the call. If somebody else has started a call already, the button will change in a green ``🎥 Join call`` button.
|
||||
|
||||
.. image:: images/join-call.png
|
||||
|
||||
During a call, you can mute your microphone and disable your video with the buttons on your video on the bottom-right, or using the shortcuts ``m`` to mute audio and ``v`` to disable video. You can also use the space bar to toggle mute. When you are muted, pressing space will unmute you so you can speak until you let go of the space bar. If you are unmuted, pressing space will mute you until you let go.
|
||||
|
||||
You can hide your video (useful during a screen share) with the little arrow just above the video stream. Bring it back with the little arrow again.
|
||||
|
||||
You can access your settings and choose a different webcam, microphone and other settings in the ``...`` menu on your video.
|
||||
|
||||
.. image:: images/call-menu.png
|
||||
|
||||
.. image:: images/call-settings.png
|
||||
|
||||
.. image:: images/talk-settings.png
|
||||
|
||||
Starting a screen share
|
||||
-----------------------
|
||||
|
||||
You can click the monitor icon on your video stream to share your screen. Depending on your browser, you will get the option to share a monitor, an application window or a single browser tab.
|
||||
|
||||
|
||||
Changing view in a call
|
||||
-----------------------
|
||||
|
||||
You can switch the view in a call with the little four-block icon in the top-right between promoted-view and grid view. The grid view will show everyone equally big and if the people do not fit on the screen, buttons will appear on the left and right that let you navigate.
|
||||
|
||||
.. image:: images/talk-grid-view.png
|
||||
|
||||
The promoted view shows the speaker large and others in a row below. If the people do not fit on the screen, buttons will appear on the left and right that let you navigate.
|
||||
|
||||
.. image:: images/talk-promoted-view.png
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||