Skip to main content
This guide helps you install and set up ImageFlow.

​
Prerequisites

  • Go 1.22 or higher
  • Node.js 18 or higher (for building the frontend)
  • WebP tools (libwebp-tools)
  • AVIF tools (libavif-apps)
  • Redis (optional, for metadata and tag storage)
  • Docker and Docker Compose (optional, for containerized deployment)

​
Installation

​
Docker deployment

  1. Clone the repository 
    git clone https://github.com/Yuri-NagaSaki/ImageFlow.git
cd ImageFlow
  2. Configure environment variables Copy the example env file and edit it: 
    cp .env.example .env
# Edit the .env file
    Ensure Docker can read this .env file, or configure the variables directly in docker-compose.yaml.
  3. Start the service 
    docker compose up -d

​
Local build deployment

  1. Clone the repository 
    git clone https://github.com/Yuri-NagaSaki/ImageFlow.git
cd ImageFlow
  2. Configure environment variables 
    cp .env.example .env
# Edit the .env file
  3. Build and start 
    docker compose -f docker-compose-build.yml up --build -d
⌘I