Skip to content

Update Installation Docs #6296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 3, 2024
Merged

Update Installation Docs #6296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1895b6
Update 010_INSTALL_AUTOMATED.md
hipsterusername May 1, 2024
0a79246
Update INSTALLATION.md
hipsterusername May 1, 2024
e7dcdaf
Update README.md
hipsterusername May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

Invoke is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. Invoke offers an industry leading web-based UI, and serves as the foundation for multiple commercial products.

[Installation][installation docs] - [Documentation and Tutorials][docs home] - [Bug Reports][github issues] - [Contributing][contributing docs]
[Installation and Updates][installation docs] - [Documentation and Tutorials][docs home] - [Bug Reports][github issues] - [Contributing][contributing docs]

<div align="center">

Expand Down
8 changes: 5 additions & 3 deletions docs/installation/010_INSTALL_AUTOMATED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Automatic Install
# Automatic Install & Updates

The installer is used for both new installs and updates.
**The same packaged installer file can be used for both new installs and updates.**
Using the installer for updates will leave everything you've added since installation, and just update the core libraries used to run Invoke.
Simply use the same path you installed to originally.

Both release and pre-release versions can be installed using it. It also supports install a wheel if needed.
Both release and pre-release versions can be installed using the installer. It also supports install through a wheel if needed.

Be sure to review the [installation requirements] and ensure your system has everything it needs to install Invoke.

Expand Down
11 changes: 9 additions & 2 deletions docs/installation/INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
# Installation Overview
# Installation and Updating Overview

Before installing, review the [installation requirements] to ensure your system is set up properly.

See the [FAQ] for frequently-encountered installation issues.

If you need more help, join our [discord] or [create an issue].

<h2>Automatic Install</h2>
<h2>Automatic Install & Updates </h2>

✅ The automatic install is the best way to run InvokeAI. Check out the [installation guide] to get started.

⬆️ The same installer is also the best way to update InvokeAI - Simply rerun it for the same folder you installed to.

The installation process simply manages installation for the core libraries & application dependencies that run Invoke.
Any models, images, or other assets in the Invoke root folder won't be affected by the installation process.

<h2>Manual Install</h2>

If you are familiar with python and want more control over the packages that are installed, you can [install InvokeAI manually via PyPI].

Updates are managed by reinstalling the latest version through PyPi.

<h2>Developer Install</h2>

If you want to contribute to InvokeAI, consult the [developer install guide].
Expand Down