Skip to content

Installation and update

Jump to bottom
Euchale edited this page Oct 9, 2024 · 5 revisions

Installation

Update - 2024/04/07: Added one-click installer or Windows (WSL2), check installation steps for details.

Update: Added one click installer for Windows install-docker.ps1, check installation steps for details.

Keep in mind this hasn't been tested, please report any issues here

One-Click Windows WSL2 (RECOMMENDED)

  1. Install Forge and/orAutomatic1111 webui and/or ComfyUI if you haven't yet
  2. Download latest One-Click Installer from latest release
  3. Unzip the downloaded archive
  4. Run .\one-click-installer-wsl.bat
  5. Set the WSL user name and password if it's your first time using it. Make sure you remember the password you entered
  6. To start the application open run-windows-wsl.bat
  7. Start the SD backend of your choice
    1. Forge/Automatic1111 webui and make sure to add --api --listen to COMMANDLINE_ARGS under webui-user.sh or webui-user.bat depending on the operating system
    2. ComfyUI
      1. Install A8R8 supporting nodes
      2. Add --preview-method auto --listen to the run command, ex: python main.py --preview-method auto --listen --max-upload-size 500
      3. Install https://github.com/ssitu/ComfyUI_UltimateSDUpscale
      4. Install https://github.com/Fannovel16/comfyui_controlnet_aux
      5. Install https://github.com/Kosinkadink/ComfyUI-Advanced-ControlNet
      6. Install https://github.com/Acly/comfyui-inpaint-nodes and follow steps on to download required models
      7. Install https://github.com/cubiq/ComfyUI_IPAdapter_plus and follow steps on to download required models

 

NOTE: To use regional prompting with Forge, make sure to install the Forge Couple extension >= v1.5.0 to your Forge installation

NOTE: You can copy the example_user.sh file and rename it to user.sh to configure tha application.

NOTE: If you're running the stable diffusion backend (Forge / A1111 / ComfyUI) on a remote machine, make sure to set the remote address in user.sh and uncomment the URL entries.

NOTE: You can define the default backend selected on startup by setting DEFAULT_BACKEND in user.sh.

 

Docker (not actively updated)

  1. Install Automatic1111 webui and/or ComfyUI if you haven't yet
  2. Clone this repo and open a terminal at the root directory
  3. On Windows you can run install-docker.ps1 in a powershell window (recommended) or:
    1. Install Docker Compose
    2. Run docker compose build
  4. Start the SD backend of your choice
    1. Automatic1111 webui and make sure to add --api --listen to COMMANDLINE_ARGS under webui-user.sh or webui-user.bat depending on the operating system
    2. ComfyUI
      1. Install A8R8 supporting nodes
      2. Add --preview-method auto --listen to the run command, ex: python main.py --preview-method auto --listen --max-upload-size 500
      3. Install https://github.com/ssitu/ComfyUI_UltimateSDUpscale
      4. Install https://github.com/Fannovel16/comfyui_controlnet_aux
      5. Install https://github.com/Kosinkadink/ComfyUI-Advanced-ControlNet
      6. Install https://github.com/Acly/comfyui-inpaint-nodes and follow steps on to download required model
      7. Install https://github.com/cubiq/ComfyUI_IPAdapter_plus and follow steps on to download required model

 

Windows (EXPERIMENTAL / BROKEN)

  1. Clone this repo and open a terminal at the root directory
  2. Run install.ps1 in a powershell window

 

Mac

  1. Download latest One-Click Installer from latest release
  2. Run xcode-select --install to install developer tools, and follow the installation prompts
  3. Install Homebrew from https://brew.sh/
  4. Run CLONE_REPO=true ./install-mac.sh (preferably from a terminal window)

Or

  1. Run xcode-select --install to install developer tools, and follow the installation prompts
  2. Install Homebrew from https://brew.sh/
  3. Clone repo
  4. Run ./install-mac.sh within the cloned directory (preferably from a terminal window)

 

Start the SD backend of your choice

  1. Automatic1111 webui and make sure to add --api --listen to COMMANDLINE_ARGS under webui-user.sh or webui-user.bat depending on the operating system
  2. ComfyUI
    1. Install A8R8 supporting nodes
    2. Add --preview-method auto --listen to the run command, ex: python main.py --preview-method auto --listen --max-upload-size 500
    3. Install https://github.com/ssitu/ComfyUI_UltimateSDUpscale
    4. Install https://github.com/Fannovel16/comfyui_controlnet_aux
    5. Install https://github.com/Kosinkadink/ComfyUI-Advanced-ControlNet
    6. Install https://github.com/Acly/comfyui-inpaint-nodes and follow steps on to download required model
    7. Install https://github.com/cubiq/ComfyUI_IPAdapter_plus and follow steps on to download required model

 

Linux (Debian based)

Ubuntu 22.04:

  1. Download latest One-Click Installer from latest release
  2. Run ./install-packaged.sh

Or

  1. Download latest One-Click Installer from latest release
  2. Run CLONE_REPO=true ./install.sh

Or

  1. Clone repo
  2. Run ./install.sh

 

Start the SD backend of your choice

  1. Automatic1111 webui and make sure to add --api --listen to COMMANDLINE_ARGS under webui-user.sh or webui-user.bat depending on the operating system
  2. ComfyUI
    1. Install A8R8 supporting nodes
    2. Add --preview-method auto --listen to the run command, ex: python main.py --preview-method auto --listen --max-upload-size 500
    3. Install https://github.com/ssitu/ComfyUI_UltimateSDUpscale
    4. Install https://github.com/Fannovel16/comfyui_controlnet_aux
    5. Install https://github.com/Kosinkadink/ComfyUI-Advanced-ControlNet
    6. Install https://github.com/Acly/comfyui-inpaint-nodes and follow steps on to download required model
    7. Install https://github.com/cubiq/ComfyUI_IPAdapter_plus and follow steps on to download required model

 

NOTE: To use regional prompting with Forge, make sure to install the Forge Couple extension >= v1.5.0 to your Forge installation

 

Getting Started

Generating Images

Clone this wiki locally