Merge main

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+Hi there, these instructions are meant for the developers of this project.
+
+If you only want to use the Stable Diffusion UI, you've downloaded the wrong file. In that case, please download and follow the instructions at https://github.com/cmdr2/stable-diffusion-ui#installation
+
+Thanks
+
+# For developers:
+
+If you would like to contribute to this project, there is a discord for dicussion:
+[![Discord Server](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/u9yhsFmEkB)
+
+## Development environment for UI (frontend and server) changes
+This is in-flux, but one way to get a development environment running for editing the UI of this project is:
+(swap `.sh` or `.bat` in instructions depending on your environment, and be sure to adjust any paths to match where you're working)
+
+1) `git clone` the repository, e.g. to `/projects/stable-diffusion-ui-repo`
+2) Download the pre-built end user archive from the link on github, and extract it, e.g. to `/projects/stable-diffusion-ui-archive`
+3) `cd /projects/stable-diffusion-ui-archive` and run the script to set up and start the project, e.g. `start.sh`
+4) Check you can view and generate images on `localhost:9000`
+5) Close the server, and edit `/projects/stable-diffusion-ui-archive/scripts/on_env_start.sh`
+6) Comment out the line near the bottom that copies the `files/ui` folder, e.g. `cp -Rf sd-ui-files/ui ui` for `.sh` or `@xcopy sd-ui-files\ui ui /s /i /Y` for `.bat`
+7) Delete the current `ui` folder at `/projects/stable-diffusion-ui-archive/ui`
+8) Now make a symlink between the repository clone (where you will be making changes) and this archive (where you will be running stable diffusion):
+`ln -s /projects/stable-diffusion-ui-repo/ui /projects/stable-diffusion-ui-archive/ui`
+or for Windows
+`mklink /D \projects\stable-diffusion-ui-archive\ui \projects\stable-diffusion-ui-repo\ui` (link name first, source repo dir second)
+9) Run the archive again `start.sh` and ensure you can still use the UI.
+10) Congrats, now any changes you make in your repo `ui` folder are linked to this running archive of the app and can be previewed in the browser.
+
+Check the `ui/frontend/build/README.md` for instructions on running and building the React code.
+
+## Development environment for Installer changes
+Build the Windows installer using Windows, and the Linux installer using Linux. Don't mix the two, and don't use WSL. An Ubuntu VM is fine for building the Linux installer on a Windows host.
+
+1. Install Miniconda 3 or Anaconda.
+2. Install `conda install -c conda-forge -y conda-pack`
+3. Open the Anaconda Prompt. Do not use WSL if you're building for Windows.
+4. Run `build.bat` or `./build.sh` depending on whether you're in Windows or Linux.
+5. Compress the `stable-diffusion-ui` folder created inside the `dist` folder. Make a `zip` for Windows, and `tar.xz` for Linux (smaller files, and Linux users already have tar).
+6. Make a new GitHub release and upload the Windows and Linux installer builds.

Troubleshooting.md

@@ -1,5 +1,19 @@
 Common issues and their solutions. If these solutions don't work, please feel free to ask at the [discord server](https://discord.com/invite/u9yhsFmEkB) or [file an issue](https://github.com/cmdr2/stable-diffusion-ui/issues).
 
+## RuntimeError: CUDA out of memory
+This can happen if your PC has less than 6GB of VRAM.
+
+Try disabling the "Turbo mode" setting under "Advanced Settings", since that takes an additional 1 GB of VRAM (to increase the speed).
+
+Additionally, a common reason for this error is that you're using an initial image larger than 768x768 pixels. Try using a smaller initial image.
+
+Also try generating smaller sized images.
+
+## ClobberError: This transaction has incompatible packages due to a shared path
+On Windows, please ensure that you had placed the `stable-diffusion-ui` folder after unzipping to the root of C: or D: (or any drive). For e.g. `C:\stable-diffusion-ui`. **Note:** This has to be done **before** you start the installation process. If you have already installed (and are facing this error), please delete the installed folder, and start fresh by unzipping and placing the folder at the top of your drive.
+
+This error can also be caused if you already have conda/miniconda/anaconda installed, due to package conflicts. Please open your Anaconda Prompt, and run `conda clean --all` to clean up unused packages.
+
 ## Green image generated
 This usually happens if you're running NVIDIA 1650 or 1660 Super. To solve this, please close and run the Stable Diffusion command on your computer. If you're using the older Docker-based solution (v1), please upgrade to v2: https://github.com/cmdr2/stable-diffusion-ui/tree/v2#installation
 
@@ -25,4 +39,4 @@ After this, you can access the server at `http://localhost:1337` (where 1337 is
 ## RuntimeError: CUDA error: unknown error
 Please ensure that you have an NVIDIA GPU and the latest [NVIDIA driver](http://www.nvidia.com/Download/index.aspx), and that you've installed [nvidia-container-toolkit](https://stackoverflow.com/a/58432877).
 
-Also, if you are using WSL (Windows), please ensure you have the latest WSL kernel by running `wsl --shutdown` and then `wsl --update`. (Thanks [AndrWeisR](https://github.com/AndrWeisR))
+Also, if you are using WSL (Windows), please ensure you have the latest WSL kernel by running `wsl --shutdown` and then `wsl --update`. (Thanks [AndrWeisR](https://github.com/AndrWeisR))

scripts/on_env_start.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 printf "\n\nStable Diffusion UI\n\n"
 
 if [ -f "scripts/install_status.txt" ] && [ `grep -c sd_ui_git_cloned scripts/install_status.txt` -gt "0" ]; then

scripts/on_sd_start.sh

@@ -1,4 +1,6 @@
-# cp sd-ui-files/scripts/on_env_start.sh scripts/
+#!/bin/bash
+
+cp sd-ui-files/scripts/on_env_start.sh scripts/
 
 source installer/etc/profile.d/conda.sh
 

scripts/post_activate.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 conda-unpack
 
 source $CONDA_PREFIX/etc/profile.d/conda.sh

scripts/start.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 source installer/bin/activate
 
 conda-unpack