diff --git a/docs/installation/INSTALL.md b/docs/installation/INSTALL.md index a1a85c212c..ea211696a2 100644 --- a/docs/installation/INSTALL.md +++ b/docs/installation/INSTALL.md @@ -9,14 +9,14 @@ experience and preferences. 1. [InvokeAI installer](INSTALL_INVOKE.md) - This is a an installer script that installs InvokeAI and all its - the essential third party libraries. When a new version of - InvokeAI is released, you will run another script to upgrade to - the new version. + This is a installer script that installs InvokeAI and all the + third party libraries it depends on. When a new version of + InvokeAI is released, you will download and reinstall the new + version. This installer is designed for people who want the system to "just - work", and have no interest in exploring how it works or - contributing enhancements to the code or documentation. + work", don't have an interest in tinkering with it, and do not + care about upgrading to unreleased experimental features. 2. [Source code installer](INSTALL_SOURCE.md) diff --git a/docs/installation/INSTALL_INVOKE.md b/docs/installation/INSTALL_INVOKE.md new file mode 100644 index 0000000000..48800ff4aa --- /dev/null +++ b/docs/installation/INSTALL_INVOKE.md @@ -0,0 +1,52 @@ +--- +title: InvokeAI Installer +--- + +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. + +Before you begin, make sure that you meet the [hardware +requirements](index.md#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. + +## Steps to Install + +1. Download the [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest) + of InvokeAI's installer for your platform + +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 + +5. Double-click 'install.bat' (Windows), or 'install.sh' (Lin/Mac) (or run from a terminal) + +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 + +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. diff --git a/docs/installation/INSTALL_SOURCE.md b/docs/installation/INSTALL_SOURCE.md index da3d8584ee..6e3fa5f9ee 100644 --- a/docs/installation/INSTALL_SOURCE.md +++ b/docs/installation/INSTALL_SOURCE.md @@ -4,9 +4,12 @@ title: The InvokeAI Source Installer ## Introduction -The source installer is a shell script that attempts to automate -every step needed to install and run InvokeAI on a stock computer -running recent versions of Linux, MacOSX or Windows. +The source installer is a shell script that attempts to automate every +step needed to install and run InvokeAI on 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 with the option to +upgrade to experimental versions later. It is not as foolproof as the +[InvokeAI installer](INSTALL_INVOKE.md) Before you begin, make sure that you meet the [hardware requirements](index.md#Hardware_Requirements) and has the appropriate @@ -22,14 +25,15 @@ libraries and recommended model weights files. Though there are multiple steps, there really is only one click involved to kick off the process. -1. The source installer is distributed in ZIP files. Download the one -that is appropriate for your operating system: +1. The source installer is distributed in ZIP files. Go to the [latest + release](https://github.com/invoke-ai/InvokeAI/releases/latest), and + look for a series of files named: - !!! todo "Change the URLs after release" - - - [invokeAI-mac.zip](https://github.com/invoke-ai/InvokeAI/releases/download/2.1.3-rc1/invokeAI-mac.zip) - - [invokeAI-linux.zip](https://github.com/invoke-ai/InvokeAI/releases/download/2.1.3-rc1/invokeAI-linux.zip) - - [invokeAI-windows.zip](https://github.com/invoke-ai/InvokeAI/releases/download/2.1.3-rc1/invokeAI-windows.zip) + - invokeAI-src-installer-mac.zip + - invokeAI-src-installer-windows.zip + - invokeAI-src-installer-linux.zip + +Download the one that is appropriate for your operating system. 2. Unpack the zip file into a directory that has at least 18G of free space. Do *not* unpack into a directory that has an earlier version of diff --git a/source_installer/create_installers.sh b/source_installer/create_installers.sh index 0a5a59da73..a925526703 100755 --- a/source_installer/create_installers.sh +++ b/source_installer/create_installers.sh @@ -8,8 +8,8 @@ mkdir -p invokeAI cp install.sh invokeAI cp readme.txt invokeAI -zip -r invokeAI-src-linux.zip invokeAI -zip -r invokeAI-src-mac.zip invokeAI +zip -r invokeAI-src-installer-linux.zip invokeAI +zip -r invokeAI-src-installer-mac.zip invokeAI # make the installer zip for windows rm -rf invokeAI @@ -17,6 +17,6 @@ mkdir -p invokeAI cp install.bat invokeAI cp readme.txt invokeAI -zip -r invokeAI-src-windows.zip invokeAI +zip -r invokeAI-src-installer-windows.zip invokeAI echo "The installer zips are ready to be distributed.."