From d460a26665fd523a6b3a31f2a16871a3859fc8c7 Mon Sep 17 00:00:00 2001
From: sldless <67599596+sldless@users.noreply.github.com>
Date: Wed, 17 Dec 2025 01:32:53 -0500
Subject: [PATCH 1/2] docs: add quick start and manual installation
 instructions to README.md; create install.sh script for automated setup

---
 README.md  |  15 +++++++
 install.sh | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 135 insertions(+)
 create mode 100755 install.sh

diff --git a/README.md b/README.md
index 1eec0ae..6ecbc98 100644
--- a/README.md
+++ b/README.md
@@ -119,6 +119,21 @@ Your system is now ready to proceed with installation, but before we continue, y
 
 Your domain (or a subdomain) should point to the server's IP (A and AAAA records) or CNAME to the hostname provided.
 
+### Quick Start
+
+To install Stoat quickly, you can use the automated installation script:
+
+```bash
+git clone https://github.com/stoatchat/self-hosted
+cd self-hosted
+chmod +x install.sh
+./install.sh
+```
+
+### Manual Installation
+
+If you prefer to install manually, follow the steps below.
+
 Next, we must install the required dependencies:
 
 ```bash
diff --git a/install.sh b/install.sh
new file mode 100755
index 0000000..906170f
--- /dev/null
+++ b/install.sh
@@ -0,0 +1,120 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+OS="$(uname -s)"
+ENV_FILE=".env.web"
+
+read -p "Would you like to answer setup questions? (y/n): " answerSetup
+
+if [ "$OS" = "Linux" ]; then
+    echo "Installing required packages (Git, curl, ca-certificates)..."
+    sudo apt-get update
+    sudo apt-get install -y git curl ca-certificates
+fi
+
+if ! command -v docker >/dev/null 2>&1; then
+    echo "Docker not found. Installing."
+    case "$OS" in
+        Linux)
+            curl -fsSL https://get.docker.com | sh
+            ;;
+        Darwin)
+            echo "Please install Docker Desktop for macOS from https://www.docker.com/products/docker-desktop and start it."
+            exit 1
+            ;;
+        MINGW*|MSYS*|CYGWIN*)
+            echo "Please install Docker Desktop for Windows and start it."
+            exit 1
+            ;;
+        *)
+            echo "Unsupported platform"
+            exit 1
+            ;;
+    esac
+else
+    echo "Docker already installed"
+fi
+
+if [ ! -d .git ]; then
+    if command -v git >/dev/null 2>&1; then
+        git clone https://github.com/stoatchat/self-hosted
+        cd self-hosted || exit 1
+        ENV_FILE=".env.web"
+    else
+        echo "Git not found. Please install Git and re-run the script."
+        exit 1
+    fi
+else
+    if [ -f .git/config ]; then
+        echo "Git repo already present"
+        cd "$(git rev-parse --show-toplevel)" || exit 1
+        ENV_FILE=".env.web"
+    else
+        echo "Git repo already present but not recognized. Check manually."
+        exit 1
+    fi
+fi
+
+if [ ! -f "$ENV_FILE" ]; then
+    echo "Creating default $ENV_FILE file"
+    touch "$ENV_FILE"
+
+    if [ "$answerSetup" = "y" ] || [ "$answerSetup" = "Y" ]; then
+        while true; do
+            read -p "Enter the hostname for your instance (e.g., http://local.stoat.chat): " HOSTNAME
+            if [[ "$HOSTNAME" == http://* ]] || [[ "$HOSTNAME" == https://* ]]; then
+                break
+            else
+                echo "Invalid input. Please include http:// or https://"
+            fi
+        done
+
+        while true; do
+            read -p "Enter the public URL for your instance API (e.g., http://local.stoat.chat/api): " REVOLT_PUBLIC_URL
+            if [[ "$REVOLT_PUBLIC_URL" == http://* ]] || [[ "$REVOLT_PUBLIC_URL" == https://* ]]; then
+                break
+            else
+                echo "Invalid input. Please include http:// or https://"
+            fi
+        done
+
+        echo "HOSTNAME=$HOSTNAME" > "$ENV_FILE"
+        echo "REVOLT_PUBLIC_URL=$REVOLT_PUBLIC_URL" >> "$ENV_FILE"
+    fi
+else
+    echo "$ENV_FILE already exists. Skipping creation."
+fi
+
+if [ ! -f Revolt.toml ]; then
+    echo "Creating default Revolt.toml file"
+    curl -O https://raw.githubusercontent.com/revoltchat/backend/main/crates/core/config/Revolt.toml
+    chmod +x ./generate_config.sh
+    ./generate_config.sh "$(grep HOSTNAME "$ENV_FILE" | cut -d '=' -f2 | sed 's~http[s]*://~~;s~/api~~')"
+else
+    echo "Revolt.toml already exists. Skipping creation."
+fi
+
+
+echo
+echo "Setup complete!"
+echo
+if command -v docker >/dev/null 2>&1; then
+    echo "Starting Stoat services with 'docker compose up -d'..."
+    if docker compose up -d; then
+        echo "Stoat is now running in the background."
+    else
+		echo
+        echo "Failed to start Docker services. Please ensure Docker is running and try:"
+        echo "  docker compose up -d"
+    fi
+else
+    echo "Docker not detected. Start Docker and then run:"
+    echo "  docker compose up -d"
+fi
+echo
+if [ "$OS" = "Linux" ]; then
+    echo "You might need to run:"
+    echo "  sudo usermod -aG docker \$USER"
+    echo "and then log out and back in to use Docker without sudo."
+fi
+

From e37476b4a8f9cbe0f641c077957b7064e4cc34f1 Mon Sep 17 00:00:00 2001
From: sldless <67599596+sldless@users.noreply.github.com>
Date: Thu, 18 Dec 2025 15:30:39 -0500
Subject: [PATCH 2/2] feat: enhance install script to support multiple package
 managers and improve dependency installation

---
 install.sh | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 63 insertions(+), 4 deletions(-)

diff --git a/install.sh b/install.sh
index 906170f..19ef22e 100755
--- a/install.sh
+++ b/install.sh
@@ -6,12 +6,71 @@ ENV_FILE=".env.web"
 
 read -p "Would you like to answer setup questions? (y/n): " answerSetup
 
-if [ "$OS" = "Linux" ]; then
-    echo "Installing required packages (Git, curl, ca-certificates)..."
-    sudo apt-get update
-    sudo apt-get install -y git curl ca-certificates
+SUDO=""
+if [ "$(id -u)" -ne 0 ] && command -v sudo >/dev/null 2>&1; then
+    SUDO="sudo"
 fi
 
+install_dependencies() {
+    echo "Installing required packages (git, curl, ca-certificates)..."
+    if command -v apt-get >/dev/null 2>&1 || command -v apt >/dev/null 2>&1; then
+        $SUDO apt-get update -y || $SUDO apt update -y 
+        $SUDO apt-get install -y git curl ca-certificates || $SUDO apt install -y git curl ca-certificates
+        return
+    fi
+
+    if command -v apk >/dev/null 2>&1; then
+        $SUDO apk update
+        $SUDO apk add git curl ca-certificates
+        return
+    fi
+    
+    if command -v dnf >/dev/null 2>&1; then
+        $SUDO dnf install -y git curl ca-certificates
+        return
+    fi
+
+    if command -v yum >/dev/null 2>&1; then
+        $SUDO yum install -y git curl ca-certificates
+        return
+    fi
+
+    if command -v zypper >/dev/null 2>&1; then
+        $SUDO zypper refresh
+        $SUDO zypper install -y git curl ca-certificates
+        return
+    fi
+
+    if command -v pacman >/dev/null 2>&1; then
+        $SUDO pacman -Sy --noconfirm git curl ca-certificates
+        return
+    fi
+
+    echo "Could not detect a supported package manager. Please install git, curl, and ca-certificates manually."
+}
+
+case "$OS" in
+    Linux)
+        install_dependencies;;
+    Darwin)
+        echo "Checking for Homebrew (macOS)..."
+        if command -v brew >/dev/null 2>&1; then
+            echo "Installing git and curl via Homebrew..."
+            brew update
+            brew install git curl
+            echo "macOS manages CA certificates by default; no action needed."
+        else
+            echo "Homebrew not found. Install from https://brew.sh and re-run this script."
+        fi
+        ;;
+    MINGW*|MSYS*|CYGWIN*)
+        echo "Windows detected. Please use WSL or install dependencies manually (Git, curl, Docker Desktop)."
+        ;;
+    *)
+        echo "Unsupported platform: $OS"
+        ;;
+esac
+
 if ! command -v docker >/dev/null 2>&1; then
     echo "Docker not found. Installing."
     case "$OS" in