Update README.md
This commit is contained in:
parent
3d5410fbc4
commit
8f668b2249
1 changed files with 49 additions and 1 deletions
48
README.md
48
README.md
|
@ -1 +1,49 @@
|
|||
# Pandabot
|
||||
|
||||
## Description
|
||||
|
||||
**Pandabot** is a flexible bot that offers various features such as database integration, file forwarding and interactivity with users via Telegram. With a customizable configuration and PostgreSQL support, the bot is ideal for automating file and communication processes.
|
||||
|
||||
---
|
||||
|
||||
### Requirements
|
||||
- PostgreSQL**: Installed and configured.
|
||||
- Apache Webserver**: For the integration (optional).
|
||||
- Python**: Depending on the script requirements (version not specified).
|
||||
- Telegram Account
|
||||
|
||||
### Directory structure
|
||||
- A download folder: `downloads` (relative to the bot's directory).
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
1. **Clone repository**:
|
||||
```bash
|
||||
git clone https://git.n64.cc/hx/Pandabot.git
|
||||
cd Pandabot
|
||||
```
|
||||
|
||||
2. set up **database**:
|
||||
- Create a PostgreSQL database with the default values from ``pandabot.conf`` or customize it.
|
||||
|
||||
3. install **dependencies** (if needed):
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. customize **configuration files**:
|
||||
- Edit `pandabot.conf` and `channels.conf` to customize the settings accordingly (see below).
|
||||
|
||||
---
|
||||
|
||||
## Configuration files
|
||||
|
||||
### `pandabot.conf`
|
||||
|
||||
#### Important parameters
|
||||
- **Botcommand**: Command for bot interactions. Default: `paul`.
|
||||
- **DB connection**: Customize the following fields:
|
||||
- `dbhost`: IP address of the database server (default: `127.0.0.1`).
|
||||
- `dbport`: Port of the database (default: `5432`).
|
Loading…
Add table
Reference in a new issue