Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dvir-cohen1/nextcloud-chatbot-fastapi
A FastAPI service for integrating chatbots with Nextcloud, providing webhook support for real-time interactions.
https://github.com/dvir-cohen1/nextcloud-chatbot-fastapi
bot fastapi nextcloud python
Last synced: about 1 month ago
JSON representation
A FastAPI service for integrating chatbots with Nextcloud, providing webhook support for real-time interactions.
- Host: GitHub
- URL: https://github.com/dvir-cohen1/nextcloud-chatbot-fastapi
- Owner: Dvir-Cohen1
- Created: 2024-08-04T14:05:53.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T23:04:23.000Z (3 months ago)
- Last Synced: 2024-10-09T19:04:06.467Z (about 1 month ago)
- Topics: bot, fastapi, nextcloud, python
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FastAPI Chatbot Service
## Overview
This repository contains a FastAPI service that acts as a chatbot for integration with Nextcloud. The service listens for webhook events from Nextcloud and processes them accordingly. The setup involves running the FastAPI application locally and connecting it to Nextcloud, which runs in a Docker container.
## Features
- **Webhook Integration**: Listens for and processes incoming webhook requests from Nextcloud.
- **FastAPI Framework**: Utilizes FastAPI for creating the web service.
## Prerequisites
1. **Python 3.8+**: Ensure you have Python 3.8 or newer installed.
2. **FastAPI**: Install FastAPI and `uvicorn` for running the app.
3. **Nextcloud**: Running in a Docker container.
4. **Docker** (for Nextcloud): Ensure Docker is installed if using Docker for Nextcloud.
## Setup Instructions
### 1. Clone the Repository
```bash
git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name
```
### 2. Create a Virtual Environment
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
### 3. Install Dependencies
```bash
pip install -r requirements.txt
```
### requirements.txt should include:
```plaintext
fastapi
uvicorn
httpx
```
### 4. Create and Set Environment Variables
```bash
# .env file
NEXTCLOUD_BOT_SECRET=
NEXTCLOUD_URL=http:
```
### 5. Run the FastAPI Application
```bash
# In Development
uvicorn main:app --host --port 8000
```
This command starts the FastAPI server locally at http://:8000/.
## Connecting to Nextcloud
Ensure the Nextcloud instance is running and reachable.
### 1. Install the Bot in Nextcloud
Use the following command to install and configure the bot:
```bash
# Replace <> with your actual details.
php /var/www/html/occ talk:bot:install --feature bots-v1
```
See full documntation here: [OCC documentation](https://nextcloud-talk.readthedocs.io/en/stable/occ/#talkbotinstall)
### 2. Verify Webhook Communication
Send a test message from Nextcloud and ensure that your FastAPI service logs or processes the message as expected. If communication fails, ensure that Nextcloud can reach the bot address.
### 3. Enable Bot in chat
- optional: Create new chat in Talk app and give it a name eg: Bot
- Enable bot in chat setting.
- send any message.
## Screenshot
## Commands
- Run the FastAPI Application: uvicorn main:app --reload
- Install Python Dependencies: pip install -r requirements.txt
- Activate Virtual Environment: source venv/bin/activate (Windows: venv\Scripts\activate)
## Troubleshooting
- Connection Issues: If you receive errors like Failed to connect, ensure that the FastAPI service is running and accessible from the Nextcloud Docker container. You may need to adjust Docker networking settings or use the IP address of the host machine instead of localhost.
- Dependency Errors: Make sure all dependencies are installed and correctly listed in requirements.txt.
## Acknowledgements
- FastAPI
- Nextcloud