From d70087494ffabad23674042ab0cb1dfd5c80483a Mon Sep 17 00:00:00 2001
From: Zaid <zaidkhann2101@gmail.com>
Date: Sun, 7 Dec 2025 01:56:11 +0530
Subject: [PATCH] Fix: added setup instructions for Linux, Windows, and macOS
 (#4826)

---
 .../01-getting-started/setup/linux_setup.rst  | 47 +++++++++++++++++++
 .../01-getting-started/setup/macos_setup.rst  | 45 ++++++++++++++++++
 .../setup/windows_setup.rst                   | 42 +++++++++++++++++
 3 files changed, 134 insertions(+)
 create mode 100644 docs/source/01-getting-started/setup/linux_setup.rst
 create mode 100644 docs/source/01-getting-started/setup/macos_setup.rst
 create mode 100644 docs/source/01-getting-started/setup/windows_setup.rst

diff --git a/docs/source/01-getting-started/setup/linux_setup.rst b/docs/source/01-getting-started/setup/linux_setup.rst
new file mode 100644
index 0000000000..ba88a43d61
--- /dev/null
+++ b/docs/source/01-getting-started/setup/linux_setup.rst
@@ -0,0 +1,47 @@
+Linux Setup Guide
+=================
+
+EvalAI officially supports setup using Docker on all platforms. Manual setup without Docker is not recommended for production environments.
+
+Prerequisites
+--------------
+
+- Docker
+- Docker Compose
+- Git
+
+Install Docker and Docker Compose using:
+
+sudo apt update  
+sudo apt install docker.io docker-compose git -y  
+
+Start Docker:
+
+sudo systemctl start docker  
+sudo systemctl enable docker  
+
+Verify installation:
+
+docker --version  
+docker-compose --version  
+
+Setup Steps
+------------
+
+1. Clone the EvalAI repository:
+
+git clone https://github.com/Cloud-CV/EvalAI.git  
+cd EvalAI  
+
+2. Run the platform using Docker:
+
+docker-compose up --build  
+
+3. Open your browser and go to:
+
+http://localhost:8080  
+
+Notes
+------
+
+Docker-based installation ensures consistent setup across all Linux distributions.
diff --git a/docs/source/01-getting-started/setup/macos_setup.rst b/docs/source/01-getting-started/setup/macos_setup.rst
new file mode 100644
index 0000000000..3de2afb46e
--- /dev/null
+++ b/docs/source/01-getting-started/setup/macos_setup.rst
@@ -0,0 +1,45 @@
+macOS Setup Guide
+=================
+
+EvalAI on macOS works using Docker Desktop.
+
+Prerequisites
+--------------
+
+- Docker Desktop
+- Git
+- Homebrew (optional for installing Docker)
+
+Install Docker Desktop from:
+
+https://www.docker.com/products/docker-desktop
+
+If using Homebrew:
+
+brew install --cask docker
+
+Verify installation:
+
+docker --version  
+docker-compose --version  
+
+Setup Steps
+------------
+
+1. Clone the EvalAI repository:
+
+git clone https://github.com/Cloud-CV/EvalAI.git  
+cd EvalAI  
+
+2. Run the platform using:
+
+docker-compose up --build  
+
+3. Open your browser and go to:
+
+http://localhost:8080  
+
+Notes
+------
+
+Docker ensures consistent setup across all macOS versions. Manual installation without Docker is not officially supported.
diff --git a/docs/source/01-getting-started/setup/windows_setup.rst b/docs/source/01-getting-started/setup/windows_setup.rst
new file mode 100644
index 0000000000..685a68a2de
--- /dev/null
+++ b/docs/source/01-getting-started/setup/windows_setup.rst
@@ -0,0 +1,42 @@
+Windows Setup Guide
+====================
+
+EvalAI setup on Windows is officially supported using Docker Desktop.
+
+Prerequisites
+--------------
+
+- Docker Desktop
+- Git
+
+Install Docker Desktop from:
+
+https://www.docker.com/products/docker-desktop
+
+After installing Docker, restart your system.
+
+Verify installation using:
+
+docker --version  
+docker-compose --version  
+
+Setup Steps
+------------
+
+1. Clone the EvalAI repository:
+
+git clone https://github.com/Cloud-CV/EvalAI.git  
+cd EvalAI  
+
+2. Start the platform using:
+
+docker-compose up --build  
+
+3. Open your browser and go to:
+
+http://localhost:8080  
+
+Notes
+------
+
+Manual non-Docker installation is not officially supported on Windows.