EML Docs

System requirements

Before installing the EML ecosystem, ensure that your server meets the following system requirements.

EML AdminTool requirements

VPS, server, or testing environment

EML AdminTool works on every platform supporting Docker (Linux, macOS, Windows). However, for production environments, a Linux-based (for example, Ubuntu or Debian) VPS or dedicated server is recommended.

Hardware requirements

Minimum requirementRecommended requirement
CPU2 vCPU4+ vCPUs
RAM2 GB4+ GB
Total storage25 GB50+ GB SSD

Note

The requirements above are based on Ubuntu 20.04 LTS. Debian can be used with lower specifications.

Warning

Launchers can make many requests to EML AdminTool. If your Minecraft server doesn’t have a lot of players, you can use a VPS with low requirements. However, if you have a lot of players, you should use a VPS with high requirements, to avoid any performance issues or crashes.

Software requirements

  • Operating System: A recent version of a Linux distribution (Ubuntu 20.04 LTS or later, Debian 10 or later) is recommended for production environments. Other operating systems are supported for testing purposes.
  • Docker: A tutorial to install Docker and Docker Compose can be found at Get Docker.
  • Web Server / Reverse Proxy: NGINX (recommended) or Apache is required to expose EML AdminTool securely to the internet. No tutorial is provided to install a web server; please refer to the official documentation of your chosen web server. A tutorial to configure NGINX as a reverse proxy for EML AdminTool is provided at Set up NGINX.
  • cURL or wget: Required to download files from the internet during installation and updates.

While not strictly necessary, it is highly recommended to have a domain name pointing to your server’s IP address. This allows for easier access to EML AdminTool and enables SSL certificate generation for secure connections.

Please refer to your domain registrar’s and hosting provider’s documentations for instructions on setting up DNS records (A, CNAME) to point your domain name to your server’s IP address.

Note

For the rest of this tutorial, the domain at.emlproject.pages.dev will be used as an example.

EML Lib requirements

Computer(s)

To develop and build an EML Lib-based launcher, you need a computer that can run Node.js and npm (Node Package Manager). Most modern computers should meet these requirements.

Note

To build a launcher for Windows, you need a Windows computer (or a Windows VM). To build a launcher for macOS, you need a macOS computer. To build a launcher for Linux, you can use any operating system.

Software requirements

  • Node.js and npm: Version 20.x (LTS) is recommended. A tutorial to install Node.js can be found at Set up environment.
  • IDE: An Integrated Development Environment (IDE) such as Visual Studio Code is recommended for editing the launcher’s source code. No specific tutorial is provided for this step.