> ## Documentation Index
> Fetch the complete documentation index at: https://visual-layer-mintlify-b738e5e2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the fastdup CLI

For most cases, installation is as simple as:

```bash theme={null}
pip3 install -U pip 
pip3 install -U fastdup
```

Latest fastdup is available for Mac M1 12 and higher, Ubuntu 20 and higher, Windows 10 and higher (via WSL).

Legacy versions are: Ubuntu 18, CentOS 7, Mac Intel.

#### Below we list common issues and prerequisites for various platforms:

1. [Ubuntu 22.04/20.04 Preliminaries](#ubuntu)
2. [Mac OSX Preliminaries](#macosx)
3. [CentOS 7 Preliminaries](#centos7)
4. [Amazon Linux 2](#amazon_linux)
5. [Windows Server 10 Preliminaries](#windows10)
6. [Pypi setup using pip](#pypi)
7. [Preinstalled docker](#docker)
8. [Common installation errors](#common)

fastdup is currently supported on Ubuntu 20.04/22.04/24.04 or 18.04 OS, CentOS 7.9, Amazon Linux 2, RedHat 4.8, Mac OS 10+ using Intel or M1 CPUs, and Windows 10, 11 Server (via WSL).

***

## Ubuntu 24.04/22.04/20.04 LTS Machine Setup <a name="ubuntu" />

Required machine setup:

```bash theme={null}
sudo apt update
sudo apt -y install software-properties-common
sudo add-apt-repository -y ppa:deadsnakes/ppa
sudo apt update
sudo apt -y install python3.9
sudo apt -y install python3-pip
sudo apt -y install libgl1-mesa-glx
python3.9 -m pip install --upgrade pip
```

***

## Mac OS Setup <a name="macosx" />

```bash theme={null}
# Install python:
brew install python@3.9
python3.9 -m pip install --U pip
python3.9 -m pip install fastdup
```

> **Note**: When using conda on Mac M1 or Mac M1 Pro, make sure you install conda for ARM (and not conda for Intel). Otherwise, it will not be possible to install.

***

## CentOS 7 Setup / Amazon Linux 2 / RedHat 4.8 <a name="centos7" />

```bash theme={null}
sudo yum -y install epel-release
sudo yum -y update
sudo yum -y groupinstall "Development Tools"
sudo yum -y install openssl-devel bzip2-devel libffi-devel xz-devel
sudo yum -y install wget
sudo yum install redhat-lsb-core # for lsb_release
sudo yum install -y ffmpeg ffmpeg-devel # for video support
```

Download and install the CentOS 7 `.whl` image from our [release page](https://github.com/visual-layer/fastdup/releases).

```bash theme={null}
python3.7 -m pip install <path of the downloaded whl>
```

***

## Amazon Linux 2 Setup <a name="amazon_linux" />

```bash theme={null}
sudo yum install mesa-libGL -y
```

Download and install the CentOS 7 `.whl` image from our [release page](https://github.com/visual-layer/fastdup/releases).

```bash theme={null}
python3.7 -m pip install <path of the downloaded whl>
```

***

## Windows 10/11 Server/Pro Setup Using WSL2 <a name="windows10" />

### Setting up WSL2

The below instructions are for Windows Server 10. More detailed instructions are [here](https://learn.microsoft.com/en-us/windows/wsl/install-on-server).

For Windows 10+11, follow the instructions [here](https://learn.microsoft.com/en-us/windows/wsl/install).

* Enable WSL on your machine (Search -> PowerShell -> right-click -> Run as Administrator):

```powershell theme={null}
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
Enable-WindowsOptionalFeature -Online -FeatureName VirtualMachinePlatform
```

* Reboot your machine.
* Check that WSL is enabled using the command:

```powershell theme={null}
Get-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
```

* Download Ubuntu 22.04 from [https://aka.ms/wslubuntu2204](https://aka.ms/wslubuntu2204).
* After the download, run PowerShell as admin, go to your download folder (e.g., `C:\Users\YourName\Downloads`):

```powershell theme={null}
cd C:\Users\YourName\Downloads
Expand-Archive .\Ubuntu_2204.zip .\Ubuntu_2204
cd .\Ubuntu_2204\
.\ubuntu2204.exe
```

This will take a few minutes. You will see an output like:

```plaintext theme={null}
Please create a default UNIX user account. The username does not need to match your Windows username.
Enter new UNIX username: your_username
Enter new UNIX password: ********
Retype new UNIX password: ********
passwd: password updated successfully
Installation successful!
```

### Optional: Update WSL to version 2 (recommended for significant performance improvements)

* Download the installer from [https://wslstorestorage.blob.core.windows.net/wslblob/wsl\_update\_x64.msi](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi).
* Run the installer and follow the instructions.

***

## Pip Package Setup <a name="pypi" />

This is the recommended installation method for all Mac, Ubuntu 18-20, Debian 10, and Windows Server 10.

```bash theme={null}
python3.9 -m pip install -U pip
python3.9 -m pip install fastdup
```

***

## Docker <a name="docker" />

### Pull from Docker Hub

```bash theme={null}
docker pull karpadoni/fastdup-ubuntu-20.04
```

### Build Your Own Docker

```bash theme={null}
docker build -f Dockerfile -t fastdup-ubuntu .
```

***

## Common Installation Issues and Their Solutions <a name="common" />

### Error: `fastdup-0.39-cp38-cp38-manylinux_2_31_x86_64.whl is not a supported wheel on this platform`

* Ensure you are on Ubuntu 20.04 or 18.04 (via `lsb_release -r`) or Mac M1 Big Sur/Mac Intel Mojave (via `sw_vers`).
* Ensure you are using the correct Python version (e.g., Python 3.8).
* Update pip: `python3.8 -m pip install -U pip`.
* Install using `python3.8 -m pip install ...` instead of `pip install ...`.

***