From 68b9b7065f9a6656e1668fcad7ae826e051aad59 Mon Sep 17 00:00:00 2001
From: first <first@noreply.git.r21.io>
Date: Mon, 7 Jul 2025 04:11:41 +0000
Subject: [PATCH] Add Getting Started: A Step-by-Step Guide

---
 Getting Started%3A A Step-by-Step Guide.-.md | 68 ++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 Getting Started%3A A Step-by-Step Guide.-.md

diff --git a/Getting Started%3A A Step-by-Step Guide.-.md b/Getting Started%3A A Step-by-Step Guide.-.md
new file mode 100644
index 0000000..aedb535
--- /dev/null
+++ b/Getting Started%3A A Step-by-Step Guide.-.md	
@@ -0,0 +1,68 @@
+This guide will walk you through the entire process from zero to a fully automated backup.
+
+#### **Step 1: System Prerequisites**
+
+Ensure the server where `regularbm` will run meets the following requirements:
+
+1.  **OS:** A Debian-based Linux distribution (e.g., Debian, Ubuntu).
+2.  **Docker:** Docker must be installed and running the Open WebUI container.
+3.  **Permissions:** The user executing the script must have permission to run `docker` commands. You can grant this by adding the user to the `docker` group:
+    ```bash
+    sudo usermod -aG docker $USER
+    # IMPORTANT: You must log out and log back in for this change to take effect.
+    ```
+4.  **Python:** Python 3 and its virtual environment tool must be available.
+    ```bash
+    sudo apt update
+    sudo apt install -y python3-venv
+    ```
+
+#### **Step 2: Deploy Cloud Infrastructure**
+
+Use the provided CloudFormation template to create the necessary AWS resources.
+
+1.  Navigate to the **CloudFormation** service in the AWS Console.
+2.  Click **Create stack** -> **With new resources (standard)**.
+3.  Select **Template is ready** -> **Direct input** and paste the contents of `cloudformation_template.yaml`.
+4.  Follow the prompts, providing a stack name and globally unique names for your S3 buckets.
+5.  On the final page, acknowledge that CloudFormation will create IAM resources and click **Create stack**.
+6.  Wait for the stack status to become `CREATE_COMPLETE`.
+
+#### **Step 3: Configure the Script Environment**
+
+It is highly recommended to run the script in an isolated Python virtual environment.
+
+1.  Place the `regularbm.py` script in its intended directory (e.g., `/opt/scripts/regularbm`).
+2.  Navigate to that directory and create the environment:
+    ```bash
+    cd /opt/scripts/regularbm
+    python3 -m venv venv
+    ```
+3.  Activate the environment and install dependencies:
+    ```bash
+    source venv/bin/activate
+    pip install boto3 lz4
+    ```
+
+#### **Step 4: Configure Server Permissions**
+
+Follow the appropriate pattern from the **Core Concepts** section.
+
+-   **If using an EC2 instance (Pattern A):** Attach the IAM Instance Profile created by CloudFormation (its name is in the stack's "Outputs" tab) to your EC2 instance via the console (**Actions** > **Security** > **Modify IAM role**).
+-   **If using an external server (Pattern B):** Manually create a dedicated IAM User with a narrowly scoped policy and place the generated static keys in the `~/.aws/credentials` file on the server. Ensure file permissions are set to `600`.
+
+#### **Step 5: Test and Automate**
+
+1.  **Run Manually:** Perform a test run to ensure everything is configured correctly.
+    ```bash
+    # Activate the venv if you haven't already
+    source /opt/scripts/regularbm/venv/bin/activate
+    
+    # Run the script with your parameters
+    ./regularbm.py --s3-bucket "your-bucket" --s3-region "us-east-1"
+    ```
+2.  **Automate with Cron:** Once the manual test succeeds, schedule the job in your crontab (`crontab -e`). Use absolute paths for everything.
+    ```crontab
+    # Run regularbm backup daily at 09:00 UTC
+    0 9 * * * /opt/scripts/regularbm/venv/bin/python /opt/scripts/regularbm/regularbm.py --s3-bucket "your-bucket" --s3-region "us-east-1" >> /var/log/regularbm.log 2>&1
+    ```