Getting Started with Erugo

This guide will walk you through the process of setting up and running your own instance of Erugo, the secure self-hosted file-sharing platform.

System Requirements

Before you begin, ensure your system meets the following requirements:

  • Docker and Docker Compose installed
  • Internet connection for pulling the Docker image
  • At least 1GB of RAM (2GB recommended)
  • Sufficient disk space for file storage

Quick Deployment with Docker

Erugo is designed to be easily deployed using Docker, making the setup process straightforward even for those with minimal server experience.

Step 1: Create a Docker Compose File

Create a new file named docker-compose.yml and copy the following configuration:

services:
  app:
    image: wardy784/erugo:latest
    restart: unless-stopped
    volumes:
      - ./storage:/var/www/html/storage
    ports:
      - "9998:80"
    networks:
      - erugo

networks:
  erugo:
    driver: bridge

This configuration:

  • Uses the latest Erugo image from Docker Hub
  • Maps the container's storage directory to a local folder
  • Exposes the application on port 9998
  • Creates a dedicated network for the container

Step 2: Start Erugo

Open a terminal, navigate to the directory containing your docker-compose.yml file, and run:

docker compose up -d

The -d flag runs the container in detached mode (in the background).

Step 3: Access the Web Interface

Once the container is running, open your web browser and navigate to:

http://localhost:9998

If you're accessing Erugo on a remote server, replace localhost with your server's IP address or domain name.

Step 4: Complete the Setup Wizard

On first access, Erugo will guide you through a setup wizard where you can create your initial administrator account.

Follow the on-screen instructions to complete the initial setup.

Next Steps

After completing the initial setup, you're ready to start using Erugo! Check out the Further Configuration page for details on customising your instance and the full range of available options.

Getting Help

If you encounter issues during installation:

With these steps completed, your Erugo instance should be up and running, ready to provide secure, controlled file sharing for you and your users.