# Requirements

> MadelineProto requires the mbstring, xml, json, fileinfo, gmp, openssl, iconv, gd extensions to function properly.

MadelineProto requires the `mbstring`, `xml`, `json`, `fileinfo`, `gmp`, `openssl`, `iconv`, `gd` extensions to function properly.

The `ffi` and `uv` extensions, the [MadelineCrypto](https://github.com/danog/MadelineCrypto) extension and the `nghttp2` library are also highly recommended to improve performance.

**[MadelineCrypto](https://github.com/danog/MadelineCrypto) is optional, but recommended for performance.** It's MadelineProto's native cryptography extension: without it MadelineProto works the same, using PHP implementations of the same algorithms, but with it MTProto encryption runs off the PHP thread, and calls and the generation of authorization keys are much faster.

The [docker image](https://docs.madelineproto.xyz/docs/DOCKER.html) already includes it. Elsewhere, install it with [PIE](https://github.com/php/pie) (prebuilt for Linux, Mac OS and Windows):

```bash
pie install danog/madelinecrypto
```

**PHP 8.3+ is required, 8.4 is recommended**.

MadelineProto explicitly supports Linux and UNIX systems (including Mac OS).  
I **don't recommend using Windows**: MadelineProto generally works on Windows, though there might be some random issues caused by AV engines, so I personally recommend using Linux.  

**Mac OS+Docker note**: If you encounter issues running MadelineProto on Docker on Mac OS, make sure to enable ephemeral filesystem support with a database [as described here »](https://docs.madelineproto.xyz/docs/DATABASE.html#ephemeral-filesystems), and change the session path in `bot.php` to point to a unique path in `/tmp`, not in a mounted volume.

Running on webservers and webhosts is fully supported, but I highly recommend running long-running applications like [event handler bots](https://docs.madelineproto.xyz/docs/UPDATES.html) via CLI.  

**Running via docker is highly recommended**, see [here »](https://docs.madelineproto.xyz/docs/DOCKER.html) for more info on how to run MadelineProto in docker, on any Linux distro.  

Otherwise, see [here »](#ubuntu) for more info on how to install MadelineProto dependencies manually on Ubuntu.  

## Docker (recommended)

Follow [these instructions »](https://docs.madelineproto.xyz/docs/DOCKER.html) to install MadelineProto dependencies on *any linux distro*, using the official docker image.  

## Ubuntu

To install MadelineProto dependencies manually on Ubuntu, run the following command in your command line:

```bash
sudo apt-get update
sudo apt-get install software-properties-common -y
sudo LC_ALL=C.UTF-8 add-apt-repository -y ppa:ondrej/php
sudo apt-get update
sudo apt-get install php8.4 php8.4-dev php8.4-xml php8.4-zip php8.4-gmp php8.4-cli php8.4-mbstring php8.4-ffi php8.4-iconv php-pear libuv1-dev nghttp2 -y
sudo pecl install uv-beta
echo extension=uv.so | sudo tee $(php --ini | sed '/additional .ini/!d;s/.*: //g')/uv.ini
echo ffi.enable=1 | sudo tee $(php --ini | sed '/additional .ini/!d;s/.*: //g')/ffi.ini

echo 262144 | sudo tee /proc/sys/vm/max_map_count
echo vm.max_map_count=262144 | sudo tee /etc/sysctl.d/40-madelineproto.conf

sudo mkdir -p /etc/security/limits.d/

echo '* soft nofile 1048576' | sudo tee -a /etc/security/limits.d/40-madelineproto.conf
echo '* hard nofile 1048576' | sudo tee -a /etc/security/limits.d/40-madelineproto.conf

# Optional, recommended for performance: MadelineCrypto
curl -fsSL -o /tmp/pie.phar https://github.com/php/pie/releases/latest/download/pie.phar
sudo install /tmp/pie.phar /usr/local/bin/pie
sudo pie install danog/madelinecrypto

```

The `max_map_count` sysctl configuration is required to avoid "Fiber stack allocate failed" and "Fiber stack protect failed" errors, since the PHP engine mmaps two memory regions per fiber, and the `soft/hard nofile` limits increase the maximum open FD limit, to allow opening many TCP sockets for improved upload and download performance, and to avoid errors.  

<a href="https://docs.madelineproto.xyz/docs/DOCKER.html">Next section</a>