Skip to content

vedantterse/XyloMail

Repository files navigation

XyloMail - Secure & Anonymous File Transfer

XyloMail Logo

Simple email-based file transfer service - perfect for public computers.

What it does

XyloMail lets you:

  • Upload files (up to 4.5MB)
  • Send them to any email address
  • No sign-in required
  • Files delivered as ZIP archives

Why use it?

Perfect for when you need to send files from a public/shared computer without logging into your personal email account.

Tech Stack

Getting Started

Follow these steps to get a local copy of XyloMail up and running.

Prerequisites

  • Node.js v18.x or later
  • npm, yarn, or pnpm package manager

Installation & Setup

  1. Clone the repository:

    git clone https://github.com/your-username/xylo-mail-next.git
    cd xylo-mail-next
  2. Install dependencies:

    npm install
  3. Set up environment variables: Create a file named .env in the root of your project and add the following variables. You can get these credentials from your email service providers (Brevo, SMTP2GO, etc.).

    # Brevo (Sendinblue) Configuration
    BREVO_API_KEY=your_brevo_api_key
    BREVO_SENDER_EMAIL=[email protected]
    BREVO_SENDER_NAME=XyloMail
    
    # SMTP Fallback Configuration
    SMTP_HOST=your_smtp_host
    SMTP_PORT=587
    SMTP_USER=your_smtp_username
    SMTP_PASS=your_smtp_password
    SMTP_FROM_EMAIL=[email protected]
    SMTP_FROM_NAME=XyloMail
  4. Run the development server:

    npm run dev
  5. Open http://localhost:3000 in your browser to see the application.

Running with Docker

Alternatively, you can run the project in a Docker container for a consistent development environment.

  1. Prerequisites:

    • Docker must be installed and running.
  2. Build and run the container: This command will build the Docker image and start the container in the background. It will automatically use the variables from your .env file.

    docker-compose up --build -d
  3. Access the application: Open http://localhost:3000 in your browser.

  4. To stop the container:

    docker-compose down

About

Simple email-based file transfer service

Resources

Stars

Watchers

Forks

Languages