|
| 1 | +# Invoke Community Edition Quick Start |
| 2 | + |
| 3 | +Welcome to Invoke! Follow these steps to install, update, and get started creating. |
| 4 | + |
| 5 | +## Step 1: System Requirements |
| 6 | + |
| 7 | +Invoke runs on Windows 10+, macOS 14+ and Linux (Ubuntu 20.04+ is well-tested). |
| 8 | + |
| 9 | +Hardware requirements vary significantly depending on model and image output size. The requirements below are rough guidelines. |
| 10 | + |
| 11 | +- All Apple Silicon (M1, M2, etc) Macs work, but 16GB+ memory is recommended. |
| 12 | +- AMD GPUs are supported on Linux only. The VRAM requirements are the same as Nvidia GPUs. |
| 13 | + |
| 14 | +!!! info "Hardware Requirements (Windows/Linux)" |
| 15 | + |
| 16 | + === "SD1.5 - 512×512" |
| 17 | + |
| 18 | + - GPU: Nvidia 10xx series or later, 4GB+ VRAM. |
| 19 | + - Memory: At least 8GB RAM. |
| 20 | + - Disk: 10GB for base installation plus 30GB for models. |
| 21 | + |
| 22 | + === "SDXL - 1024×1024" |
| 23 | + |
| 24 | + - GPU: Nvidia 20xx series or later, 8GB+ VRAM. |
| 25 | + - Memory: At least 16GB RAM. |
| 26 | + - Disk: 10GB for base installation plus 100GB for models. |
| 27 | + |
| 28 | + === "FLUX - 1024×1024" |
| 29 | + |
| 30 | + - GPU: Nvidia 20xx series or later, 10GB+ VRAM. |
| 31 | + - Memory: At least 32GB RAM. |
| 32 | + - Disk: 10GB for base installation plus 200GB for models. |
| 33 | + |
| 34 | +More detail on system requirements can be found [here](./requirements.md). |
| 35 | + |
| 36 | +## Step 2: Download |
| 37 | + |
| 38 | +Download the most launcher for your operating system: |
| 39 | + |
| 40 | +- [Download for Windows](https://download.invoke.ai/Invoke-Installer-windows-x64.exe) |
| 41 | +- [Download for macOS](https://download.invoke.ai/Invoke-Installer-mac-arm64.dmg) |
| 42 | +- [Download for Linux](https://download.invoke.ai/Invoke-Installer-linux-x86_64.AppImage) |
| 43 | + |
| 44 | +## Step 3: Install or Update |
| 45 | + |
| 46 | +Run the launcher you just downloaded, click **Install** and follow the instructions to get set up. |
| 47 | + |
| 48 | +If you have an existing Invoke installation, you can select it and let the launcher manage the install. You'll be able to update or launch the installation. |
| 49 | + |
| 50 | +!!! warning "Problem running the launcher on macOS" |
| 51 | + |
| 52 | + macOS may not allow you to run the launcher. We are working to resolve this by signing the launcher executable. Until that is done, you can either use the [legacy scripts](./legacy_scripts.md) to install, or manually flag the launcher as safe: |
| 53 | + |
| 54 | + - Open the **Invoke-Installer-mac-arm64.dmg** file. |
| 55 | + - Drag the launcher to **Applications**. |
| 56 | + - Open a terminal. |
| 57 | + - Run `xattr -cr /Applications/Invoke-Installer.app`. |
| 58 | + |
| 59 | + You should now be able to run the launcher. |
| 60 | + |
| 61 | +## Step 4: Launch |
| 62 | + |
| 63 | +Once installed, click **Finish**, then **Launch** to start Invoke. |
| 64 | + |
| 65 | +The very first run after an installation or update will take a few extra moments to get ready. |
| 66 | + |
| 67 | +!!! tip "Server Mode" |
| 68 | + |
| 69 | + The launcher runs Invoke as a desktop application. You can enable **Server Mode** in the launcher's settings to disable this and instead access the UI through your web browser. |
| 70 | + |
| 71 | +## Step 5: Install Models |
| 72 | + |
| 73 | +With Invoke started up, you'll need to install some models. |
| 74 | + |
| 75 | +The quickest way to get started is to install a **Starter Model** bundle. If you already have a model collection, Invoke can use it. |
| 76 | + |
| 77 | +!!! info "Install Models" |
| 78 | + |
| 79 | + === "Install a Starter Model bundle" |
| 80 | + |
| 81 | + 1. Go to the **Models** tab. |
| 82 | + 2. Click **Starter Models** on the right. |
| 83 | + 3. Click one of the bundles to install its models. Refer to the [system requirements](#step-1-confirm-system-requirements) if you're unsure which model architecture will work for your system. |
| 84 | + |
| 85 | + === "Use my model collection" |
| 86 | + |
| 87 | + 4. Go to the **Models** tab. |
| 88 | + 5. Click **Scan Folder** on the right. |
| 89 | + 6. Paste the path to your models collection and click **Scan Folder**. |
| 90 | + 7. With **In-place install** enabled, Invoke will leave the model files where they are. If you disable this, **Invoke will move the models into its own folders**. |
| 91 | + |
| 92 | +You’re now ready to start creating! |
| 93 | + |
| 94 | +## Step 6: Learn the Basics |
| 95 | + |
| 96 | +We recommend watching our [Getting Started Playlist](https://www.youtube.com/playlist?list=PLvWK1Kc8iXGrQy8r9TYg6QdUuJ5MMx-ZO). It covers essential features and workflows, including: |
| 97 | + |
| 98 | +- Generating your first image. |
| 99 | +- Using control layers and reference guides. |
| 100 | +- Refining images with advanced workflows. |
| 101 | + |
| 102 | +## Other Installation Methods |
| 103 | + |
| 104 | +- You can install the Invoke application as a python package. See our [manual install](./manual.md) docs. |
| 105 | +- You can run Invoke with docker. See our [docker install](./docker.md) docs. |
| 106 | +- You can still use our legacy scripts to install and run Invoke. See the [legacy scripts](./legacy_scripts.md) docs. |
| 107 | + |
| 108 | +## Need Help? |
| 109 | + |
| 110 | +- Visit our [Support Portal](https://support.invoke.ai). |
| 111 | +- Watch the [Getting Started Playlist](https://www.youtube.com/playlist?list=PLvWK1Kc8iXGrQy8r9TYg6QdUuJ5MMx-ZO). |
| 112 | +- Join the conversation on [Discord][discord link]. |
| 113 | + |
| 114 | +[discord link]: https://discord.gg/ZmtBAhwWhy |
0 commit comments