christianond/chatbridge repository overview

Chatbridge enables communication with a chatbot via the Synology "Chat" server.

Workflow: Users ask the chatbot a question. The query is routed through Chatbridge, which forwards it to an external AI service. After processing by the AI, Chatbridge transmits the response back to the chatbot within the Synology Chat system.

Features: Chatbridge is currently designed for use by a single person. Integration primarily utilizes AI models from Mistral AI (further extensions are planned). Users can upload files for analysis. HTTPS support is not available.

License: Apache License 2.0; for third-party licenses (open source), please refer to "Thirdparty-Licenses".

SourceCode can be found on www.xcomweb.de/⁠

#####################################################################################

Configuration:

By default, the Chatbridge runs on port 7070.

The provided Docker image automatically initiates the container installation after downloading. During the installation process, the Docker port mapping can be configured to 7070:7070.

Inside the running container, the following configuration files are located in the /app/data directory:

config.file

webhook.file

prompt.file

To access the container, you can use the terminal with the following command: 'docker exec -it Container-ID /bin/sh'

Then, navigate to the /app/data directory and edit the desired file using the vi editor.

config.file: Contains all necessary settings for the connection to the Synology NAS and the AI ​​integration.

Example:

"MODEL_NAME": "docker.io/ai/ministral3:latest",

"AI_URL": "http://192.168.170.58:12434/v1⁠",

"NAS_URL": "http://192.168.170.42:5000⁠",

"SERVER_PORT": 7070

webhook.file: This is where the chatbot's webhook is stored. Copy the webhook directly from the Synology "Chat" configuration into the file where "null" appears. Use "http" if you use a custom certificate.

Important: An outgoing hook must be set up in the Synology "Chat" configuration, using the Chatbridge's HTTP URL as the destination. This URL is: 'http: //Chatbridge-Server-IP:<Port/synology-bot' The Chatbridge expects an HTTP POST request via the /synology-bot route.

prompt.file: This is where the system prompt for the AI ​​is defined.

Note: There is no pre-configured default setup! All files must be customized to meet your specific requirements.

The container must be restarted after every change.