2022-11-10 18:13:28 +00:00
|
|
|
---
|
|
|
|
title: InvokeAI Installer
|
|
|
|
---
|
|
|
|
|
2022-11-11 11:19:27 +00:00
|
|
|
The InvokeAI installer is a shell script that will install InvokeAI onto a stock
|
|
|
|
computer running recent versions of Linux, MacOSX or Windows. It will leave you
|
|
|
|
with a version that runs a stable version of InvokeAI. When a new version of
|
|
|
|
InvokeAI is released, you will download and reinstall the new version.
|
|
|
|
|
|
|
|
If you wish to tinker with unreleased versions of InvokeAI that introduce
|
|
|
|
potentially unstable new features, you should consider using the
|
|
|
|
[source installer](INSTALL_SOURCE.md) or one of the
|
|
|
|
[manual install](INSTALL_MANUAL.md) methods.
|
|
|
|
|
|
|
|
!!! todo
|
|
|
|
|
|
|
|
Before you begin, make sure that you meet
|
|
|
|
the[hardware requirements](/#hardware-requirements) and has the
|
|
|
|
appropriate GPU drivers installed. In particular, if you are a Linux user with
|
|
|
|
an AMD GPU installed, you may need to install the
|
|
|
|
[ROCm-driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).
|
|
|
|
|
|
|
|
Installation requires roughly 18G of free disk space to load the libraries and
|
|
|
|
recommended model weights files.
|
2022-11-10 18:13:28 +00:00
|
|
|
|
|
|
|
## Steps to Install
|
|
|
|
|
2022-11-11 11:19:27 +00:00
|
|
|
1. Download the
|
|
|
|
[latest release](https://github.com/invoke-ai/InvokeAI/releases/latest) of
|
|
|
|
InvokeAI's installer for your platform
|
2022-11-10 18:13:28 +00:00
|
|
|
|
|
|
|
2. Place the downloaded package someplace where you have plenty of HDD space,
|
|
|
|
and have full permissions (i.e. `~/` on Lin/Mac; your home folder on Windows)
|
|
|
|
|
|
|
|
3. Extract the 'InvokeAI' folder from the downloaded package
|
|
|
|
|
|
|
|
4. Open the extracted 'InvokeAI' folder
|
|
|
|
|
2022-11-11 11:19:27 +00:00
|
|
|
5. Double-click 'install.bat' (Windows), or 'install.sh' (Lin/Mac) (or run from
|
|
|
|
a terminal)
|
2022-11-10 18:13:28 +00:00
|
|
|
|
|
|
|
6. Follow the prompts
|
|
|
|
|
|
|
|
7. After installation, please run the 'invoke.bat' file (on Windows) or
|
|
|
|
'invoke.sh' file (on Linux/Mac) to start InvokeAI.
|
|
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
|
2022-11-11 11:19:27 +00:00
|
|
|
If you run into problems during or after installation, the InvokeAI team is
|
|
|
|
available to help you. Either create an
|
|
|
|
[Issue](https://github.com/invoke-ai/InvokeAI/issues) at our GitHub site, or
|
|
|
|
make a request for help on the "bugs-and-support" channel of our
|
|
|
|
[Discord server](https://discord.gg/ZmtBAhwWhy). We are a 100% volunteer
|
|
|
|
organization, but typically somebody will be available to help you within 24
|
|
|
|
hours, and often much sooner.
|