-
-
Notifications
You must be signed in to change notification settings - Fork 390
Installation
Vladimir Mandic edited this page Jul 28, 2024
·
25 revisions
- These instructions assume that you already have Git and Python installed on your user
PATH
. If you do not have both Git and Python installed, follow the instructions in Install Python and Git to set those up first.
- Launch your preferred system terminal and navigate to the directory where you want to install SD.Next.
- This should be a directory which your user account has read/write/execute access to. Installing SD.Next in a directory which requires admin permissions may cause it to not launch properly.
- Clone the repository by running
git clone https://github.com/vladmandic/automatic <optional directory name>
in your desired location. - Navigate into the cloned directory.
- Run the appropriate launcher for your OS to start the web interface:
- Windows:
webui.bat --debug
or.\webui.ps1 --debug
- DirectML/AMD owners on Windows should additionally start with
--use-directml
.
- DirectML/AMD owners on Windows should additionally start with
- Linux:
./webui.sh --debug
- ROCm/Linux users can optionally also start with
--use-rocm
if your setup is not autodetected.
- ROCm/Linux users can optionally also start with
- Mac:
./webui.sh --debug
- Notes:
- Intel OneAPI XPU users should also start with
--use-ipex
- For the initial setup and future tech support, it is advisable to include the
--debug
option. This will provide more detailed information, which can be helpful until the Diffusers backend becomes fully feature complete from Huggingface and any potential compatibility issues are resolved.
- Intel OneAPI XPU users should also start with
- Windows:
- Let the server finish installing and launching. The server is finished launching when the console shows an entry for "Local URL" with the server's address.
- Once the web interface starts running, you can access it by opening your web browser and navigating to the address listed in the console next to "Local URL." For most users, this should be
http://localhost:7860/
. - You will see a brief loading screen, then you should be taken to the
Text
tab. - You may want to adjust these settings in the
System
tab:- If you already have models, LoRAs, Embeddings, LyCORIS, etc. set your paths in the
System Paths
page now, especially if you started with--models-dir
, since you won't need to use that argument afterwards.- Pay special attention to the
Folder with Huggingface models
entry as that is where diffusers models will download to if you use the Huggingface downloader.
- Pay special attention to the
- If you intend to use the Diffusers backend and/or SDXL, go to the
User Interface
page and addsd_model_refiner
,diffusers_pipeline
, andsd_backend
to theQuicksettings list
box. This will make controlling SDXL much easier. - Optionally, we have just added a new theme,
Amethyst-Nightfall
, (It's purple!). You can select that at the top of theUser Interface page
in theUI theme
setting.
- If you already have models, LoRAs, Embeddings, LyCORIS, etc. set your paths in the
- If you changed any settings in the previous step, click
Apply settings
to save those settings to your config file. This will also apply some defaults from built-in extensions. - Click
Restart Server
to re-launch the SD.Next server with the updated settings.
After installing and setting up SD.Next, you may find these pages useful:
You will likely want to follow Nvidia's instructions to disable System Memory Fallback for Stable Diffusion on the newest drivers, which you should be using.
To install Python and Git on Windows and macOS, please follow the instructions below:
- Download Git for Windows from the following link: Git for Windows
- Run the downloaded
.exe
file and follow the installation wizard. - During the installation process, make sure to check the box for "Use Git from the Windows Command line and also from 3rd-party-software" to add Git to your system's PATH.
- Complete the installation by following the on-screen instructions.
- Download Python for Windows from the following link: Python for Windows
- Run the downloaded
.exe
file and follow the installation wizard. - On the "Customize Python" screen, make sure to check the box for "Add Python to PATH."
- Continue the installation by following the prompts.
- Once the installation is complete, you can open the command prompt and verify that Python is installed by executing
python --version
andpip --version
to check the Python and Pip versions respectively.
- Download Git for macOS from the following link: Git for macOS
- Open the downloaded
.pkg
file and follow the installation instructions. - During the installation process, make sure to check the box for "Install Git Bash" to have a command-line Git interface.
- Complete the installation by following the prompts.
See these instructions for Python on MacOS (and an explanation why it's unique).