InvokeAI Documentation

Invoke is a leading creative engine for Stable Diffusion models, empowering professionals, artists, and enthusiasts to generate and create visual media...

27,865 stars Python Python 1 file · ~1,701 tokens #ai-art#artificial-intelligence#generative-art#image-generation#img2img#inpainting#latent-diffusion#linux
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy InvokeAI on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name invokeai --restart always ghcr.io/invoke-ai/invokeai:latest
Configured Services & Ports
⚙️ invokeai-cuda
image: ghcr.io/invoke-ai/invokeai:latest
🔌 Ports: ${INVOKEAI_PORT:-9090}:${INVOKEAI_PORT:-9090}
⚙️ invokeai-cpu
image: ghcr.io/invoke-ai/invokeai:latest
🔌 Ports: ${INVOKEAI_PORT:-9090}:${INVOKEAI_PORT:-9090}
⚙️ invokeai-rocm
image: ghcr.io/invoke-ai/invokeai:latest
🔌 Ports: ${INVOKEAI_PORT:-9090}:${INVOKEAI_PORT:-9090}
docker-compose.yml
yaml (docker-compose.yml) 
# Copyright (c) 2023 Eugene Brodsky https://github.com/ebr

x-invokeai: &invokeai
    image: "ghcr.io/invoke-ai/invokeai:latest"
    build:
      context: ..
      dockerfile: docker/Dockerfile

    # Create a .env file in the same directory as this docker-compose.yml file
    # and populate it with environment variables. See .env.sample
    env_file:
      - .env

    # variables without a default will automatically inherit from the host environment
    environment:
      # if set, CONTAINER_INVOKEAI_ROOT will override the Invoke runtime directory location *inside* the container
      - INVOKEAI_ROOT=${CONTAINER_INVOKEAI_ROOT:-/invokeai}
      - HF_HOME
    ports:
      - "${INVOKEAI_PORT:-9090}:${INVOKEAI_PORT:-9090}"
    volumes:
      - type: bind
        source: ${HOST_INVOKEAI_ROOT:-${INVOKEAI_ROOT:-~/invokeai}}
        target: ${CONTAINER_INVOKEAI_ROOT:-/invokeai}
        bind:
          create_host_path: true
      - ${HF_HOME:-~/.cache/huggingface}:${HF_HOME:-/invokeai/.cache/huggingface}
    tty: true
    stdin_open: true


services:
  invokeai-cuda:
    <<: *invokeai
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [gpu]

  invokeai-cpu:
    <<: *invokeai
    profiles:
      - cpu

  invokeai-rocm:
    <<: *invokeai
    environment:
      - AMD_VISIBLE_DEVICES=all
      - RENDER_GROUP_ID=${RENDER_GROUP_ID}
    runtime: amd
    profiles:
      - rocm

Invoke is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. Invoke offers an industry leading web-based UI, and serves as the foundation for multiple commercial products.

  • Free to use under a commercially-friendly license
  • Download and install on compatible hardware
  • Generate, refine, iterate on images, and build workflows

Documentation

Quick Links
Installation and Updates - Documentation and Tutorials - Bug Reports - Contributing

Installation

To get started with Invoke, Download the Launcher.

Troubleshooting, FAQ and Support

Please review our FAQ for solutions to common installation problems and other issues.

For more help, please join our Discord.

Features

Full details on features can be found in our documentation.

Web Server & UI

Invoke runs a locally hosted web server & React UI with an industry-leading user experience.

Unified Canvas

The Unified Canvas is a fully integrated canvas implementation with support for all core generation capabilities, in/out-painting, brush tools, and more. This creative tool unlocks the capability for artists to create with AI as a creative collaborator, and can be used to augment AI-generated imagery, sketches, photography, renders, and more.

Workflows & Nodes

Invoke offers a fully featured workflow management solution, enabling users to combine the power of node-based workflows with the ease of a UI. This allows for customizable generation pipelines to be developed and shared by users looking to create specific workflows to support their production use-cases.

Invoke features an organized gallery system for easily storing, accessing, and remixing your content in the Invoke workspace. Images can be dragged/dropped onto any Image-base UI element in the application, and rich metadata within the Image allows for easy recall of key prompts or settings used in your workflow.

Model Support

  • SD 1.5
  • SD 2.0
  • SDXL
  • SD 3.5 Medium
  • SD 3.5 Large
  • CogView 4
  • Flux.1 Dev
  • Flux.1 Schnell
  • Flux.1 Kontext
  • Flux.1 Krea
  • Flux Redux
  • Flux Fill
  • Flux.2 Dev
  • Flux.2 Klein 4B
  • Flux.2 Klein 9B
  • Z-Image Turbo
  • Z-Image Base
  • Krea 2 Turbo
  • Krea 2 Raw
  • Anima
  • Qwen Image
  • Qwen Image Edit
  • Ideogram 4
  • ERNIE-Image
  • ERNIE-Image-Turbo
  • Nano Banana (API Only)
  • GPT Image (API Only)
  • Wan (API Only)

Other features

  • Support for ckpt, diffusers, and some gguf models
  • Upscaling Tools
  • Embedding Manager & Support
  • Model Manager & Support
  • Workflow creation & management
  • Node-Based Architecture
  • Object Segmentation & Selection Models (SAM / SAM2)

Contributing

Anyone who wishes to contribute to this project - whether documentation, features, bug fixes, code cleanup, testing, or code reviews - is very much encouraged to do so.

Get started with contributing by reading our contribution documentation, joining the #dev-chat or the GitHub discussion board.

We hope you enjoy using Invoke as much as we enjoy creating it, and we hope you will elect to become part of our community.

Sponsors

Invoke's open-source development is powered by our sponsors. If Invoke is valuable to you or your business, please consider sponsoring us — it directly funds maintenance, new features, and community support.

We very much thank the following sponsors:

Backers ($15/mo)

Power Users ($50/mo)

Thanks

Invoke is a combined effort of passionate and talented people from across the world. We thank them for their time, hard work and effort.

Original portions of the software are Copyright © 2024 by respective contributors.

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#ai-art Browse ai-art catalog → #artificial-intelligence Browse artificial-intelligence catalog → #generative-art Browse generative-art catalog → #image-generation Browse image-generation catalog → #img2img Browse img2img catalog → #inpainting Browse inpainting catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →