Getting Started

Requirements

Before you begin, make sure you have the following installed on your server:

• Docker — Version 20.10 or higher
• Docker Compose — Version 2.0 or higher (included with Docker Desktop)
• At least 512MB RAM — 1GB recommended for better performance
• Storage space — Depends on your file sharing needs

Docker Compose Setup

The easiest way to deploy Erugo is using Docker Compose. Create a new directory for your Erugo installation and add a docker-compose.yml file:

services:
  app:
    image: wardy784/erugo:latest
    restart: unless-stopped
    volumes:
      - ./erugo-storage:/var/www/html/storage
    ports:
      - "8080:80"
    networks:
      - erugo
  tusd:
    image: tusproject/tusd:latest
    restart: unless-stopped
    command: -hooks-http http://app/api/tusd-hooks -upload-dir /data/app/uploads -base-path /files/ -behind-proxy
    user: "1000:1000"
    volumes:
      - ./erugo-storage:/data
    networks:
      - erugo

networks:
erugo:
  driver: bridge

Then start Erugo with:

docker compose up -d

Erugo will be available at http://localhost:8080 (or your server's IP address).

First Run

When you first access Erugo, you'll be guided through a setup wizard to:

1. Create your admin account
2. Configure basic settings
3. Set up your branding (optional)

After completing the setup, you'll be ready to start sharing files!

Configuration

Erugo is configured via the admin panel after first run. You do not need to dig into environment variables.

To learn more about all available settings including shares, email notifications, authentication providers, themes, and more, see the comprehensive Configuration Guide.

Next Steps

Now that Erugo is running, here are some things you might want to do:

• Set up a reverse proxy — Use Nginx, Caddy, or Traefik to add HTTPS and a custom domain
• Configure email — Enable email notifications for share events
• Customize branding — Add your logo and choose a theme that matches your organization
• Set up backups — Regularly backup the Docker volumes to protect your data