Skip to content

Commit

Permalink
Add Nextcloud Talk documentation (#104)
Browse files Browse the repository at this point in the history
  • Loading branch information
bertrandda authored Dec 15, 2023
1 parent 8b5075d commit cd5e3ca
Show file tree
Hide file tree
Showing 13 changed files with 116 additions and 0 deletions.
57 changes: 57 additions & 0 deletions docs/integrations/nextcloud-talk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: nextcloud-talk
title: Nextcloud Talk
sidebar_label: Nextcloud Talk
---

This integration allows you to use Nextcloud [Talk](https://nextcloud.com/talk/) app to talk to Gladys.

Available on Android, iOS and web, it will allow you to communicate with Gladys Assistant by giving it instructions, receiving information or questions...

## Nextcloud account for your bot

Bots does not exist natively in Nextcloud Talk. It is necessary to create a Nextcloud account for your bot.

On Nextcloud, login with your bot account:
1. Go to config page, then click on Security tab
2. At the bottom enter "Gladys" and click on "Create new app password"

Note the generated password

![Nextcloud Talk password](../../static/img/docs/en/configuration/nextcloud-talk/nextcloud_talk_1_app_password.png)

## Get your conversation token

To indicate which Nextcloud Talk conversation Gladys should listen to:
1. From a **browser**, with your **personnal account** on Nextcloud
2. Go to Talk application
3. Start conversation with your bot account

![Nextcloud Talk start conversation](../../static/img/docs/en/configuration/nextcloud-talk/nextcloud_talk_2_start_conversation.png)

4. Write down the token, you can find it in conversation url

![Nextcloud Talk token](../../static/img/docs/en/configuration/nextcloud-talk/nextcloud_talk_3_token.png)

## Enter full Nextcloud Talk bot configuration in Gladys Assistant

Go to "Integrations" -> "Nextcloud Talk".

![Integration Nextcloud Talk](../../static/img/docs/en/configuration/nextcloud-talk/nextcloud_talk_4_integration_list.png)

1. Enter your Nextcloud instance base url
2. Enter the username of your bot's Nextcloud account
3. Paste here previously generated password
4. Paste conversation token

Click on "Save".

![Enter bot configuration Gladys Assistant](../../static/img/docs/en/configuration/nextcloud-talk/nextcloud_talk_5_configuration.png)

## First communication between Telegram and Gladys Assistant

On Nextcloud web or mobile application, enter your first question for your Gladys Assistant, for example : what's the weather like?

Wait a bit and ......... magic !!!

Your assistant answers you ! Isn't fun ?
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
id: nextcloud-talk
title: Nextcloud Talk
sidebar_label: Nextcloud Talk
---

Cette intégration vous permet d'utiliser l'app [Talk](https://nextcloud.com/talk/) de Nextcloud pour communiquer avec Gladys.

Disponible sur Android, iOS et web, elle vous permettra de communiquer avec Gladys Assistant en lui donnant des instructions, en recevant des informations ou des questions...

## Compte Nextcloud pour votre bot

Les bots n'étant pas gérés nativement par Nextcloud Talk, il est nécessaire en plus de votre compte personnel, de créer un compte Nextcloud dédié à votre bot (lors de cette création, vous ou l'administrateur de votre instance Nextcloud devrez attribuer un petit peu d'espace disque pour gérer l'upload des photos par Gladys, 1Go devrait être suffisant).

Sur votre instance Nextcloud, connectez vous avec le compte de votre bot puis :
1. Rejoignez la page de configuration, puis l'onglet sécurité
2. En bas entrez par exemple "Gladys" et cliquez sur "Créer un nouveau mot de passe d'application"

Notez le mot de passe créé

![Nextcloud Talk mot de passe](../../../../../static/img/docs/fr/configuration/nextcloud-talk/nextcloud_talk_1_app_password.png)

## Récupérer le token de conversation

Pour indiquer la conversation de Nextcloud Talk que Gladys doit écouter :

1. Depuis un **navigateur**, accédez à votre **compte personnel** Nextcloud
2. Rendez vous dans l'application Talk
3. Démarrer une conversation avec le compte de votre bot

![Nextcloud Talk démarrer la conversation](../../../../../static/img/docs/fr/configuration/nextcloud-talk/nextcloud_talk_2_start_conversation.png)

4. Notez le token qui se trouve dans l'url de la conversation

![Nextcloud Talk token](../../../../../static/img/docs/fr/configuration/nextcloud-talk/nextcloud_talk_3_token.png)

## Entrez la configuration de votre bot dans Gladys Assistant

Allez dans "Intégrations" -> "Nextcloud Talk".

![Intégration Nextcloud Talk](../../../../../static/img/docs/fr/configuration/nextcloud-talk/nextcloud_talk_4_integration_list.png)

1. Entrez l'url de base de votre instance Nextcloud
2. Entrez ici le nom d'utilisateur du compte Nextcloud de votre bot
3. Collez ici le mot de passe précédement généré
4. Collez le token récupéré dans l'url de la conversation

Puis cliquez sur "Sauvegarder".

![Entrer une clé dans Gladys Assistant](../../../../../static/img/docs/fr/configuration/nextcloud-talk/nextcloud_talk_5_configuration.png)

## Première communication entre Nextcloud Talk et Gladys Assistant

Sur Nextcloud web ou l'application mobile, saisissez votre première question dans la conversation avec votre Assistant Gladys, par exemple : quel temps fait-il ?

Patientez un peu et ......... magie !!!

Votre assistant vous répond ! C'est cool, non ?
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module.exports = {
"integrations/google-home",
"integrations/homekit",
"integrations/mqtt",
"integrations/nextcloud-talk",
"integrations/node-red",
"integrations/openweather",
"integrations/openai",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cd5e3ca

Please sign in to comment.