Customizing Discobot for your site

:bookmark: This guide explains how to customize Discobot, the built-in assistant bot in Discourse, to better match your community’s persona and needs.

:person_raising_hand: Required user level: Administrator

Discobot is a special user in your Discourse community that helps new members learn about the platform. As an administrator, you can customize various aspects of Discobot to better fit your community’s style and requirements.

Configuring Discobot’s site settings

Discobot’s behavior is controlled by several site settings found under the Plugins settings category (search for “narrative bot” in Admin > Settings). Key settings include:

  • discourse_narrative_bot_enabled: Enables or disables the Discobot plugin entirely. Default: true.
  • disable_discourse_narrative_bot_welcome_post: When enabled, prevents Discobot from sending a welcome post to new users. Default: true (welcome post is disabled on new installations).
  • discourse_narrative_bot_welcome_post_type: Controls the type of welcome post. Options are “New user track” (starts the interactive tutorial) or “Welcome message” (sends a simple welcome message). Default: new_user_track.
  • discourse_narrative_bot_welcome_post_delay: Number of seconds to wait before sending the welcome post. Default: 0.
  • discourse_narrative_bot_ignored_usernames: A list of usernames that Discobot should not interact with. Default: discourse.
  • discourse_narrative_bot_disable_public_replies: When enabled, prevents Discobot from replying in public topics. Default: false.

:warning: On new installations, disable_discourse_narrative_bot_welcome_post defaults to true, meaning Discobot will not automatically message new users. To enable Discobot’s welcome post, set this to false.

Modifying Discobot’s user profile

To customize Discobot’s profile:

  1. Go to Admin > Users and select the Discobot user.
  2. Select “Preferences” or click “Visit this user’s preferences page to edit their profile”:

Once in the Preferences section, you can modify the following settings:

Account settings

  • Name: Click the “Edit” button to change Discobot’s name.
  • Image: Click the “Edit” button to upload a new avatar image.
  • After making changes, click the “Save Changes” button.

:bulb: If you change Discobot’s name, remember to also update its “About me” bio in the Profile section. The default bio references Discobot by description rather than username, but you may want to review it to ensure it still makes sense with the new name.

Profile settings

Customize Discobot’s profile information as needed.

Email settings

Adjust email-related settings as needed.

Updating Discobot’s welcome message

All of Discobot’s text — including the welcome message, tutorial steps, and other responses — can be customized via Appearance > Site Texts in the admin panel (/admin/customize/site_texts).

To find and edit a specific message:

  1. Go to Discobot’s profile (https://example.discourse.com/u/discobot/summary) and select “Messages”.

  2. Click on “Sent”.

  3. Find a greeting message that you want to modify.

  4. Copy a unique part of the message, such as “I’m only a robot”.

  5. Navigate to the Admin Interface (https://example.discourse.com/admin)

  6. Go to Appearance > Site Texts (https://example.discourse.com/admin/customize/site_texts)

  7. Paste the copied text into the search window. When the greeting message appears, click “Edit”.

  8. Update the greeting message and click “Save Changes”.

:bulb: You can also search for discourse_narrative_bot in Site Texts to browse all of Discobot’s customizable text strings directly.

Limitations and additional information

  • You can reuse existing variables in messages (like %{username} or %{discobot_username}), but you cannot add new ones.
  • Discobot must remain an administrator; this role cannot be removed.
  • You can customize the body content of tutorial steps but you cannot add, remove, or reorder steps.

For further customization needs or feature requests, consider posting in the #feature category.

Last edited by @hugh 2024-07-19T02:45:16Z

Last checked by @hugh 2024-07-19T02:45:34Z

Check documentPerform check on document:
38 лайков

Is it possible to make a new conversation discobot with With members and make a new certificate for them ?

I am admin to an educational forum and I want to make a new conversation with a new certificate :slight_smile:

3 лайка

No, you cannot currently customise the full experience.

3 лайка

Is it possible to know the codes for messages such as %{title}

Excuse me for my many questions :slight_smile:

1 лайк

Questions are fine. :slight_smile:

You can reuse any existing variables in the message but you cannot add new ones.

5 лайков

many thanks @HAWK
Is it possible to define the existing variables if possible? :slight_smile:

1 лайк

Предлагаю добавить одно из следующего:

  1. Пользователям необходимо обновить раздел «Обо мне» в профиле Discobot, так как после изменения его имени там всё ещё будет указано «сообщение» или упоминание @discobot.

или

  1. Возможно, в Discourse стоит убрать имя пользователя из сообщения по умолчанию? Я уже отредактировал наш раздел «Обо мне», чтобы там было написано:

Привет, я не реальный человек. Я бот, который может рассказать вам об этом сайте. Чтобы взаимодействовать со мной, отправьте мне сообщение или упомяните меня где угодно.

Так, если нам снова придётся что-то менять, не нужно будет вспоминать о необходимости обновить и раздел «Обо мне».

4 лайка

Станет ли это возможным в будущем? Текущий формат вопроса/ответа для fortune и quote достаточен для моих целей.

1 лайк

Планируется ли в нашем дорожном плане расширение функциональности discobot со стороны @codinghorror?

2 лайка

Хорошая мысль, нужно внести это исправление в текст. @tshenry, не мог бы ты этим заняться? Не обязательно обрабатывать это ретроспективно, достаточно только для новых случаев. Напиши «упоминай меня по имени», чтобы изменение имени не требовало правки раздела «Обо мне».

@hawk, в данный момент мы не планируем расширять функционал Discobot.

7 лайков

Это должно быть реализовано следующим образом!

8 лайков

Должен ли Discobot быть модератором, или я могу снять с него эту роль? Имею в виду, продолжит ли он работать в этом случае?

2 лайка

Насколько я могу судить, изучив код и интерфейс, Discobot никогда не может стать модератором.

Если вы имели в виду администратора, то, к сожалению, на данный момент нет способа лишить Discobot роли администратора.

7 лайков

Спасибо за ответ. После последних нескольких постов возможно ли настроить обучение пользователей для discobot и продвинутое обучение пользователей, или это всё ещё стандарт? У нас много поискового трафика по слову «капибара», но, возможно, мы хотели бы попробовать другое слово или термин?

1 лайк

На самом деле, я считаю, что то, о чём я говорю, может быть здесь: Customizing Discobot for your site - #7

2 лайка

Может ли администратор включить или выключить определённую часть руководства?

Например, руководство по флагам требует от пользователя выбрать флаг «Неподходящий». Этот флаг скрыт в нашем экземпляре, так как он не соответствует нашим задачам. В результате пользователи не могут завершить руководство. Если бы я мог отключить или пропустить только этот раздел, мы смогли бы снова включить руководство.

2 лайка

Вы можете изменить инструкции шага, аналогично тому, как лайк поста можно пропустить, если лайки отключены. Отключить лайки — обновить руководство для Discobot

3 лайка

Вы не можете удалять или добавлять шаги, но можете настраивать содержимое существующих шагов (но не триггеры).

4 лайка

Хотелось бы адаптировать это и обучить модель отвечать на вопросы, связанные с основной темой форума, используя LM, ChatGPT и т. д. Возможно ли это?

Скорее всего, лучше создать своего собственного AI-персонажа/бота, чем пытаться настроить discobot.

1 лайк