{"id":21614643,"url":"https://github.com/eea/volto-chatbot","last_synced_at":"2025-04-11T06:52:12.292Z","repository":{"id":251183954,"uuid":"836652285","full_name":"eea/volto-chatbot","owner":"eea","description":"Volto addon that integrates Danswer chatbot assistants","archived":false,"fork":false,"pushed_at":"2025-03-31T13:15:51.000Z","size":243,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-03-31T13:59:26.083Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eea.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-01T09:24:14.000Z","updated_at":"2025-03-20T08:00:15.000Z","dependencies_parsed_at":"2024-08-12T14:46:29.801Z","dependency_job_id":"895ccbd8-4231-422e-a7c7-443ac560550e","html_url":"https://github.com/eea/volto-chatbot","commit_stats":null,"previous_names":["eea/volto-chatbot"],"tags_count":14,"template":false,"template_full_name":"eea/volto-addon-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Fvolto-chatbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Fvolto-chatbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Fvolto-chatbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Fvolto-chatbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eea","download_url":"https://codeload.github.com/eea/volto-chatbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247785945,"owners_count":20995645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T22:08:43.897Z","updated_at":"2025-04-11T06:52:12.283Z","avatar_url":"https://github.com/eea.png","language":"JavaScript","funding_links":[],"categories":["Add-ons"],"sub_categories":[],"readme":"\n# Volto Chatbot\n\n[![Releases](https://img.shields.io/github/v/release/eea/volto-chatbot)](https://github.com/eea/volto-chatbot/releases)\n\n[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-chatbot%2Fmaster\u0026subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-chatbot/job/master/display/redirect)\n[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-master\u0026metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-master)\n[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-master\u0026metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-master)\n[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-master\u0026metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-master)\n[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-master\u0026metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-master)\n\n[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-chatbot%2Fdevelop\u0026subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-chatbot/job/develop/display/redirect)\n[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-develop\u0026metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-develop)\n[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-develop\u0026metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-develop)\n[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-develop\u0026metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-develop)\n[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-chatbot-develop\u0026metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-chatbot-develop)\n\n\n[Volto](https://github.com/plone/volto) add-on that integrates an AI-powered chatbot with a customizable interface and advanced settings to tailor its behavior and enhance user interactions.\n\n## Features\n\n\n\nhttps://github.com/user-attachments/assets/f9b5f813-672f-4e4d-81d0-bf2aec35b587\n\n\n\nThe **Volto Chatbot** block allows the integration of an AI-powered chatbot into your Volto project. It offers a customizable interface and advanced settings to tailor the chatbot's behavior to your needs. Below is an overview of its features and configuration options.\n\n\n\n---\n\n## Functionalities\n\n| **Property**              | **Description**                                                                                             | **Type**          | **Default**                 |\n|---------------------------|-------------------------------------------------------------------------------------------------------------|-------------------|-----------------------------|\n| `assistant`               | Choose from the list of available assistants configured in the application.                                | Dropdown          | -                           |\n| `qgenAsistantId`          | Select an assistant for generating related questions.                                                      | Dropdown          | -                           |\n| `enableQgen`              | Toggle the generation of related questions.                                                                | Boolean           | `false`                     |\n| `placeholderPrompt`       | Set placeholder text for the chat input field.                                                             | String            | `Ask a question`            |\n| `showAssistantTitle`      | Display or hide the assistant's title in the chat interface.                                               | Boolean           | `true`                      |\n| `showAssistantDescription`| Display or hide the assistant's description in the chat interface.                                         | Boolean           | `true`                      |\n| `showAssistantPrompts`    | Show or hide predefined prompts provided by the assistant.                                                 | Boolean           | `true`                      |\n| `chatTitle`               | Title assigned to saved chats, visible only in Danswer or analytics.                                       | String            | `Online public chat`        |\n| `height`                  | Set the height of the chat window using CSS dimensions (e.g., `500px`, `70vh`).                            | String            | -                           |\n| `scrollToInput`           | Automatically scroll the page to focus on the chat input when interacting.                                 | Boolean           | `false`                     |\n\n---\n\n\n## Getting started\n\n### Try volto-chatbot with Docker\n\n      git clone https://github.com/eea/volto-chatbot.git\n      cd volto-chatbot\n      make\n      make start\n\nGo to http://localhost:3000\n\n### Add volto-chatbot to your Volto project\n\n1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone\n\n   ```Bash\n   docker compose up backend\n   ```\n\n1. Start Volto frontend\n\n* If you already have a volto project, just update `package.json`:\n\n   ```JSON\n   \"addons\": [\n       \"@eeacms/volto-chatbot\"\n   ],\n\n   \"dependencies\": {\n       \"@eeacms/volto-chatbot\": \"*\"\n   }\n   ```\n\n* If not, create one:\n\n   ```\n   npm install -g yo @plone/generator-volto\n   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-chatbot\n   cd my-volto-project\n   ```\n\n1. Install new add-ons and restart Volto:\n\n   ```\n   yarn\n   yarn start\n   ```\n\n\n## Environment Configuration\n\nTo properly configure the middleware and authenticate with the Danswer service, ensure that the following environment variables are set:\n\n| **Environment Variable**  | **Description**                                             |\n|---------------------------|-------------------------------------------------------------|\n| `DANSWER_URL`             | The base URL of the Danswer service (e.g., `https://api.danswer.com`). |\n| `DANSWER_USERNAME`        | Username for authenticating with the Danswer service.       |\n| `DANSWER_PASSWORD`        | Password for authenticating with the Danswer service.       |\n\n### Example `.env` File\n\nCreate a `.env` file in your project root with the following content:\n\n```env\nDANSWER_URL=https://api.danswer.com\nDANSWER_USERNAME=your_username\nDANSWER_PASSWORD=your_password\n```\n If you encounter issues, double-check your `.env` configuration and ensure the Danswer service is accessible at the URL you’ve provided.\n\n\n## Release\n\nSee [RELEASE.md](https://github.com/eea/volto-chatbot/blob/master/RELEASE.md).\n\n## How to contribute\n\nSee [DEVELOP.md](https://github.com/eea/volto-chatbot/blob/master/DEVELOP.md).\n\n## Copyright and license\n\nThe Initial Owner of the Original Code is European Environment Agency (EEA).\nAll Rights Reserved.\n\nSee [LICENSE.md](https://github.com/eea/volto-chatbot/blob/master/LICENSE.md) for details.\n\n## Funding\n\n[European Environment Agency (EU)](http://eea.europa.eu)\nde is European Environment Agency (EEA).\nAll Rights Reserved.\n\nSee [LICENSE.md](https://github.com/eea/volto-addon-template/blob/master/LICENSE.md) for details.\n\n## Funding\n\n[European Environment Agency (EU)](http://eea.europa.eu)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feea%2Fvolto-chatbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feea%2Fvolto-chatbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feea%2Fvolto-chatbot/lists"}