Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions docs/source/01-getting-started/setup/linux_setup.rst
Original file line number Diff line number Diff line change
@@ -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.
45 changes: 45 additions & 0 deletions docs/source/01-getting-started/setup/macos_setup.rst
Original file line number Diff line number Diff line change
@@ -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.
42 changes: 42 additions & 0 deletions docs/source/01-getting-started/setup/windows_setup.rst
Original file line number Diff line number Diff line change
@@ -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.