Docker build files & setup

Author: FlyingFathead

README.md

@@ -43,7 +43,7 @@
 
 ---
 
-# Installing
+# Installing (No Docker)
 
 1. **Clone the repository with:**
 
@@ -91,6 +91,126 @@
 
 ---
 
+## **Dockerized Install Instructions**
+
+### **Prerequisites**
+1. **Docker** must be installed on your machine.
+   - If not installed, you can download and install it from [Docker's official site](https://www.docker.com/get-started).
+
+2. **Telegram Bot API Key** and **OpenAI API Key**:
+   - You will need a valid Telegram Bot API key. You can get one by creating a bot with [BotFather](https://core.telegram.org/bots#botfather).
+   - You will also need an OpenAI API key. If you don't have one, you can generate it from the [OpenAI API page](https://beta.openai.com/signup/).
+
+### **Step 1: Clone the Repository**
+
+First, clone the repository from GitHub:
+
+```bash
+git clone https://github.com/FlyingFathead/TelegramBot-OpenAI-API.git
+cd TelegramBot-OpenAI-API
+```
+
+### **Step 2: Run the Setup Script**
+
+This project includes a setup script that will guide you through entering your API keys and generating a `.env` file.
+
+Run the script:
+
+```bash
+./docker_setup.sh
+```
+
+Follow the instructions provided by the script. It will ask for your OpenAI API key and Telegram Bot API key, validate them, and create a `.env` file with your credentials.
+
+### **Step 3: Build the Docker Image**
+
+Once your `.env` file has been created, you need to build the Docker image.
+
+Run the following command to build the Docker image:
+
+```bash
+sudo docker build -t telegrambot-openai-api .
+```
+
+This will build the image locally based on the `Dockerfile` in the repository.
+
+### **Step 4: Run the Docker Container**
+
+After the image is successfully built, you can start the bot in a Docker container.
+
+Run the container with the following command:
+
+```bash
+sudo docker run --env-file .env -d telegrambot-openai-api
+```
+
+- The `-d` flag runs the container in detached mode (in the background).
+- The `--env-file .env` flag injects your API keys into the container.
+
+### **Step 5: Check the Running Container**
+
+You can check if the container is running by using:
+
+```bash
+sudo docker ps
+```
+
+This will list all running containers. If your bot is running correctly, it should appear in the list.
+
+### **Step 6: Stopping the Container**
+
+If you need to stop the bot, you can do so by running:
+
+```bash
+sudo docker stop <container_id>
+```
+
+Replace `<container_id>` with the actual container ID, which you can obtain from the `docker ps` output.
+
+### **Additional Steps (Optional)**
+
+- **Logs**: If you need to view the bot’s logs to troubleshoot any issues, you can use:
+
+  ```bash
+  sudo docker logs <container_id>
+  ```
+
+- **Restart the Container**: If you stop the container and want to start it again, you can either run the `docker run` command again or restart the existing container with:
+
+  ```bash
+  sudo docker start <container_id>
+  ```
+
+### **Updating the Bot**
+
+If the repository receives updates and you want to apply them, follow these steps:
+
+1. Pull the latest changes from GitHub:
+   ```bash
+   git pull origin main
+   ```
+
+2. Rebuild the Docker image:
+   ```bash
+   sudo docker build -t telegrambot-openai-api .
+   ```
+
+3. Stop the currently running container:
+   ```bash
+   sudo docker stop <container_id>
+   ```
+
+4. Start a new container using the updated image:
+   ```bash
+   sudo docker run --env-file .env -d telegrambot-openai-api
+   ```
+
+You should now have the TelegramBot-OpenAI-API running in a Docker container, fully connected to both Telegram and OpenAI. Enjoy your bot!
+
+If you run into any issues, consult the logs or reach out on the repository's [Issues page](https://github.com/FlyingFathead/TelegramBot-OpenAI-API/issues).
+
+---
+
 # Updating
 
 - Use the `configmerger.py` to update old configuration files into a newer version's `config.ini`. You can do this by saving a copy of your existing config to i.e. a file named `myconfig.txt` and including in it the lines you want to keep for the newer version. 
@@ -106,6 +226,7 @@
 ---
 
 # Changelog
+- v0.7502 - added `docker_setup.sh` for easier Docker-based deployment
 - v0.7501 - `Dockerfile` and better error catching when receiving `401 Unauthorized`
 - v0.75 **Major refactoring** _(5. Oct 2024)_ 👀💦🌀
   - entire project has been tidied up and a lot of bugs fixed while at it

docker_setup.sh

@@ -11,7 +11,7 @@ echo "Welcome to the TelegramBot-OpenAI-API setup."
 echo "Source code: https://github.com/FlyingFathead/TelegramBot-OpenAI-API/"
 echo
 
-# Function to check for empty or invalid inputs
+# Function to check for empty or invalid inputs for required keys
 validate_input() {
   if [[ -z "$1" || ${#1} -lt 10 ]]; then
     echo "Error: Input cannot be blank or too short (must be at least 10 characters). Please try again."
@@ -20,33 +20,38 @@ validate_input() {
   return 0
 }
 
-# Prompt for OpenAI API Key with validation
+# Prompt for required API keys (OpenAI and Telegram)
 while true; do
-  read -p "Please enter your OpenAI API key: " OPENAI_API_KEY
+  read -p "Please enter your OpenAI API key (required): " OPENAI_API_KEY
   validate_input "$OPENAI_API_KEY" && break
 done
 
-# Prompt for Telegram Bot API Key with validation
 while true; do
-  read -p "Please enter your Telegram Bot API key: " TELEGRAM_BOT_API_KEY
+  read -p "Please enter your Telegram Bot API key (required): " TELEGRAM_BOT_API_KEY
   validate_input "$TELEGRAM_BOT_API_KEY" && break
 done
 
-# Create a .env file with the collected keys
+# Prompt for optional API keys (user can leave them blank)
+echo "Below are optional keys for the bot's supported API functionalities that you can add in, or just press ENTER to leave them blank."
+read -p "Please enter your Perplexity API key (optional): " PERPLEXITY_API_KEY
+read -p "Please enter your OpenWeatherMap API key (optional): " OPENWEATHERMAP_API_KEY
+read -p "Please enter your WeatherAPI key (optional): " WEATHERAPI_KEY
+read -p "Please enter your MapTiler API key (optional): " MAPTILER_API_KEY
+read -p "Please enter your Openrouteservice API key (optional): " OPENROUTESERVICE_API_KEY
+
+# Create a .env file with the required and optional keys
 echo "Generating .env file..."
 cat <<EOL > .env
 OPENAI_API_KEY=$OPENAI_API_KEY
 TELEGRAM_BOT_API_KEY=$TELEGRAM_BOT_API_KEY
+OPENWEATHERMAP_API_KEY=$OPENWEATHERMAP_API_KEY
+WEATHERAPI_KEY=$WEATHERAPI_KEY
+MAPTILER_API_KEY=$MAPTILER_API_KEY
+OPENROUTESERVICE_API_KEY=$OPENROUTESERVICE_API_KEY
+PERPLEXITY_API_KEY=$PERPLEXITY_API_KEY
 # Additional variables can be added here
 EOL
 
-# Optionally, check for Docker Compose if it's needed later
-# if ! [ -x "$(command -v docker-compose)" ]; then
-#   echo 'Warning: Docker Compose is not installed. Consider installing it if needed.' >&2
-# fi
-
-
-# Inform the user the setup is complete
 echo "Environment variables saved to .env."
 
 # Instructions for the next steps
@@ -58,13 +63,28 @@ echo
 echo "2. After building the image, start the bot container using:"
 echo "   sudo docker run --env-file .env -d telegrambot-openai-api"
 echo
-echo "   This will start the bot in detached mode (-d) using the environment variables from the .env file."
-echo
-echo "3. Optionally, check if the container is running using:"
+echo "3. Check the container status with:"
 echo "   sudo docker ps"
 echo
-echo "4. To stop the container, you can run:"
+echo "4. Stop the container with:"
 echo "   sudo docker stop <container_id>"
 echo
-echo "You're all set! The bot should now be running and connected to Telegram and OpenAI."
+echo "You're all set!"
+
+function build_and_run() {
+# Build Docker image
+sudo docker build -t telegrambot-openai-api .
+if [[ $? -ne 0 ]]; then
+  echo "Error: Docker image build failed."
+  exit 1
+fi
+
+# Run Docker container
+sudo docker run --env-file .env -d telegrambot-openai-api
+if [[ $? -ne 0 ]]; then
+  echo "Error: Failed to run the Docker container."
+  exit 1
+fi
+}
 
+# build_and_run