Erugo
Star on GitHub
About Docs Get Started

Prerequisites

Before installing Erugo, make sure your system meets these requirements. Erugo is designed to be lightweight and can run on modest hardware.

Docker

Erugo runs as a Docker container, so you'll need Docker installed on your system. Docker handles all dependencies and makes deployment straightforward.

Requirement Minimum Version Notes
Docker 20.10+ Docker Engine or Docker Desktop
Docker Compose 2.0+ Included with Docker Desktop; install separately on Linux

Installing Docker

The easiest way to install Docker on most systems is using the official convenience script:

Terminal 
curl -fsSL https://get.docker.com | sh

After installation, add your user to the docker group to run commands without sudo:

Terminal 
sudo usermod -aG docker $USER
Log out required

You'll need to log out and back in for the group changes to take effect.

Verify Installation

After logging back in, verify Docker is working correctly:

Terminal 
docker run hello-world

You should see a success message confirming Docker is installed and running.

Hardware Requirements

Erugo is lightweight and can run on modest hardware. Here are the recommended specifications:

Resource Minimum Recommended Notes
CPU 1 vCPU 2+ vCPU More cores help with concurrent uploads
RAM 512 MB 1-2 GB More RAM improves performance under load
Storage 10 GB 40+ GB Scale based on expected file storage needs
Runs on Raspberry Pi

Erugo is lightweight enough to run on a Raspberry Pi 4 or similar single-board computers for home or small office use.

Network Requirements

For a basic local installation, you just need:

  • Port 8080 — Default port for accessing Erugo (configurable)

For a production deployment with HTTPS, you'll also need:

  • Port 80 — For HTTP traffic and SSL certificate verification
  • Port 443 — For HTTPS traffic
  • A domain name — Required for SSL certificates

Operating System

Erugo runs anywhere Docker runs. It's been tested on:

  • Linux — Ubuntu, Debian, CentOS, Fedora, Arch, etc.
  • macOS — Via Docker Desktop
  • Windows — Via Docker Desktop with WSL2
Production Recommendation

For production deployments, we recommend a Linux server (Ubuntu 22.04 or 24.04 LTS) for the best performance and stability.

What's Next?

Once you have Docker installed and running, you're ready to deploy Erugo. Head to the Quick Start guide to get up and running in just a few minutes.

Related Guides