mirror of
https://github.com/invoke-ai/InvokeAI.git
synced 2025-01-07 03:17:05 +08:00
Update Installation Docs
This commit is contained in:
Kent Keirsey
psychedelicious
parent
9c9cec1b43
commit
91a4160e36
@ -1,36 +1,94 @@
|
||||
# Installation and Updating Overview
|
||||
# How to Install and Update Invoke Community Edition
|
||||
|
||||
Before installing, review the [installation requirements](./requirements.md) to ensure your system is set up properly.
|
||||
Welcome to Invoke! Follow these steps to install, update, and get started with Invoke.
|
||||
|
||||
See the [FAQ](../faq.md) for frequently-encountered installation issues.
|
||||
You can also follow our [installation documentation][installation docs].
|
||||
|
||||
If you need more help, join our [discord](https://discord.gg/ZmtBAhwWhy) or [create a GitHub issue](https://github.com/invoke-ai/InvokeAI/issues).
|
||||
### Step 1: Confirm System Requirements
|
||||
|
||||
## Automated Installer & Updates
|
||||
**Before you start, ensure your system meets the following requirements:**
|
||||
|
||||
✅ The automated [installer](./installer.md) is the best way to install Invoke.
|
||||
| **Minimum Requirements** |
|
||||
|----------------------------------------------------------------------------------------------------------------------------|
|
||||
|**Operating System:** Windows 10+, macOS 11.0+, or Linux (Ubuntu 20.04+ recommended).|
|
||||
|**GPU:** |
|
||||
| - **NVIDIA:** GTX 1060 or higher (6GB VRAM), CUDA 11.3+. |
|
||||
| - **AMD:** RX 5700 or higher, ROCm 5.4+ (Linux only).|
|
||||
|**RAM:** 8GB or more.|
|
||||
|**Disk Space:** 10GB free for installation (30GB+ recommended for models).|
|
||||
|
||||
⬆️ The same installer is also the best way to update Invoke - simply rerun it for the same folder you installed to.
|
||||
**Recommended for Best Performance**
|
||||
- **GPU:** NVIDIA RTX 20 Series or AMD RDNA2 GPUs with 8GB+ VRAM.
|
||||
- **RAM:** 16GB or more.
|
||||
- **Disk Space:** 100GB if working with multiple models.
|
||||
|
||||
The installation process simply manages installation for the core libraries & application dependencies that run Invoke.
|
||||
### Step 2: Download the Launcher
|
||||
|
||||
Models, images, or other assets in the Invoke root folder won't be affected by the installation process.
|
||||
Download the most recent launcher for your operating system:
|
||||
|
||||
## Manual Install
|
||||
- [Download for Windows](https://download.invoke.ai/Invoke-Installer-windows-x64.exe)
|
||||
- [Download for macOS](https://download.invoke.ai/Invoke-Installer-mac-arm64.dmg)
|
||||
- [Download for Linux](https://download.invoke.ai/Invoke-Installer-linux-x86_64.AppImage)
|
||||
|
||||
If you are familiar with python and want more control over the packages that are installed, you can [install Invoke manually via PyPI](./manual.md).
|
||||
### Step 3: Install or Update Invoke
|
||||
|
||||
Updates are managed by reinstalling the latest version through PyPi.
|
||||
Run the launcher you just downloaded. You’ll have two options:
|
||||
|
||||
## Developer Install
|
||||
1. **Launch / update from an existing installation:**
|
||||
- If you installed Invoke previously, click *Select an existing installation* to connect to it. You'll be able to update or launch the existing installation.
|
||||
|
||||
2. **Launch from a fresh installation:**
|
||||
- Click *Install* to set up a new instance of Invoke.
|
||||
- Follow the on-screen instructions to complete the setup.
|
||||
|
||||
If you want to contribute to InvokeAI, you'll need to set up a [dev environment](../contributing/dev-environment.md).
|
||||
### Step 4: Run Invoke from Your Browser
|
||||
|
||||
## Docker
|
||||
Once installed, click Finish, then Launch to start Invoke.
|
||||
|
||||
Invoke publishes docker images. See the [docker installation guide](./docker.md) for details.
|
||||
- The very first run after an installation will take a few extra moments to get ready. It will be faster after the first run.
|
||||
|
||||
## Other Installation Guides
|
||||
### Step 5: Install a Starter Model Pack or Locate Models On Your Hard Drive
|
||||
|
||||
After launching Invoke:
|
||||
|
||||
1. Go to the **Model Manager** tab.
|
||||
2. Install one of the suggested Starter Model packs. If you already have models installed on your hard drive, you can provide that folder location and Invoke will automatically add those models to your studio.
|
||||
|
||||
You’re now ready to start creating!
|
||||
|
||||
### Step 6: Learn the Basics
|
||||
|
||||
We recommend watching the following resources to get started:
|
||||
|
||||
[**Getting Started Playlist**](https://www.youtube.com/playlist?list=PLvWK1Kc8iXGrQy8r9TYg6QdUuJ5MMx-ZO)
|
||||
|
||||
This playlist covers essential features and workflows, including:
|
||||
|
||||
- Generating your first image.
|
||||
- Using control layers and reference guides.
|
||||
- Refining images with advanced workflows.
|
||||
|
||||
---
|
||||
|
||||
## Advanced Installation Options
|
||||
|
||||
### Manual Installation
|
||||
|
||||
For detailed instructions on manual setup, see our [Manual Installation Guide](https://invoke-ai.github.io/InvokeAI/installation/manual/).
|
||||
|
||||
### Docker Installation
|
||||
|
||||
Run Invoke in a containerized environment with our [Docker Installation Guide](https://invoke-ai.github.io/InvokeAI/installation/docker/).
|
||||
|
||||
---
|
||||
|
||||
## Need Help?
|
||||
|
||||
- Visit our [Support Portal](https://support.invoke.ai).
|
||||
- Watch the [Getting Started Playlist](https://www.youtube.com/playlist?list=PLvWK1Kc8iXGrQy8r9TYg6QdUuJ5MMx-ZO).
|
||||
- Join the conversation on [Discord][discord link].
|
||||
|
||||
|
||||
[installation docs]: https://invoke-ai.github.io/InvokeAI/installation/
|
||||
[discord link]: https://discord.gg/ZmtBAhwWhy
|
||||
|
||||
- [PyPatchMatch](./patchmatch.md)
|
||||
- [Installing Models](./models.md)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user