Skip to content

Commit

Permalink
initial wave of SwarmUI rename pushes
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmonkey4eva committed Jun 21, 2024
1 parent 6071f8f commit cc9943c
Show file tree
Hide file tree
Showing 45 changed files with 123 additions and 136 deletions.
File renamed without changes
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to StableSwarmUI
# Contributing to SwarmUI

Please open an Issue or Discussion, or ask on Discord before opening a pull request, to make sure your work doesn't overlap with others.

Expand All @@ -12,7 +12,7 @@ Want to help translate Swarm into another language?
- Are you just helping improve an existing language?
- Great! Just edit the file in `languages/(language-code).json` and improve the translations included
- Do you want to add a new language?
- See example commit here: https://github.com/Stability-AI/StableSwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
- See example commit here: https://github.com/mcmonkeyprojects/SwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
- In short: copy/paste `languages/en.json` to `languages/(your-code).json`, fill out the info at the top, and start translating keys.
- Also add `src/wwwroot/imgs/flags/(your-code).jpg` as a small icon image of a flag that represents the language.
- You can use https://github.com/mcmonkeyprojects/translate-tool to fill out any keys you can't be bothered filling in yourself with automatic AI-powered translation
Expand Down
65 changes: 30 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,14 @@
# StableSwarmUI
# SwarmUI

**StableSwarmUI 0.6.4.1 Beta**.
**SwarmUI 0.9.0.0 Beta**.

A Modular Stable Diffusion Web-User-Interface, with an emphasis on making powertools easily accessible, high performance, and extensibility.

![ui-screenshot](.github/images/stableswarmui.jpg)
![ui-screenshot](.github/images/swarmui.jpg)

Join the [Discord](https://discord.gg/q2y38cqjNw) to discuss the project, get support, see announcements, etc.

Follow the [Feature Announcements Thread](https://github.com/Stability-AI/StableSwarmUI/discussions/11) for updates on new features.

# Migration Notice

As of 2024/06/21 StableSwarmUI will no longer be maintained under Stability AI.

The original developer will be maintaining an independent version of this project as [mcmonkeyprojects/SwarmUI](https://github.com/mcmonkeyprojects/SwarmUI)

Windows users can migrate to the new independent repo by simply updating and then running `migrate-windows.bat`

For Linux, Mac, or manual Windows: open a terminal in your Swarm folder then run `git remote set-url origin https://github.com/mcmonkeyprojects/SwarmUI`

See full migration guide here: https://github.com/mcmonkeyprojects/SwarmUI/discussions/2
Follow the [Feature Announcements Thread](https://github.com/mcmonkeyprojects/SwarmUI/discussions/1) for updates on new features.

----

Expand All @@ -45,7 +33,7 @@ Key feature targets not yet implemented:

**WARNING**: Google Colab does not necessarily allow remote WebUIs, particularly for free accounts, use at your own risk.

Colab link if you want to try Swarm: https://colab.research.google.com/github/Stability-AI/StableSwarmUI/blob/master/colab/colab-notebook.ipynb
Colab link if you want to try Swarm: https://colab.research.google.com/github/mcmonkeyprojects/SwarmUI/blob/master/colab/colab-notebook.ipynb

### Runpod

Expand All @@ -57,11 +45,11 @@ Note it may take several minutes to start up the first time. Check the container

Note: if you're on Windows 10, you may need to manually install [git](https://git-scm.com/download/win) and [DotNET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) first. (Windows 11 this is automated).

- Download [The Install-Windows.bat file](https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-windows.bat), store it somewhere you want to install at (not `Program Files`), and run it.
- Download [The Install-Windows.bat file](https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-windows.bat), store it somewhere you want to install at (not `Program Files`), and run it.
- It should open a command prompt and install itself.
- If it closes without going further, try running it again, it sometimes needs to run twice. (TODO: Fix that)
- It will place an icon on your desktop that you can use to re-launch the server at any time.
- When the installer completes, it will automatically launch the StableSwarmUI server, and open a browser window to the install page.
- When the installer completes, it will automatically launch the SwarmUI server, and open a browser window to the install page.
- Follow the install instructions on the page.
- After you submit, be patient, some of the install processing take a few minutes (downloading models and etc).

Expand All @@ -71,16 +59,16 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi

- Install git from https://git-scm.com/download/win
- Install DotNET 8 SDK from https://dotnet.microsoft.com/en-us/download/dotnet/8.0 (Make sure to get the SDK x64 for Windows)
- open a terminal to the folder you want swarm in and run `git clone https://github.com/Stability-AI/StableSwarmUI`
- open a terminal to the folder you want swarm in and run `git clone https://github.com/mcmonkeyprojects/SwarmUI`
- open the folder and run `launch-windows.bat`

# Installing on Linux

- Install `git`, `python3` via your OS package manager if they are not already installed (make sure to include `pip` and `venv` on distros that do not include them in python directly)
- For example, on recent Ubuntu versions, `sudo apt install git python3-pip python3-venv`
- Download [the install-linux.sh file](https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-linux.sh), store it somewhere you want to install at, and run it
- Download [the install-linux.sh file](https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh), store it somewhere you want to install at, and run it
- If you like terminals, you can open a terminal to the folder and run the following commands:
- `wget https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-linux.sh -O install-linux.sh`
- `wget https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh -O install-linux.sh`
- `chmod +x install-linux.sh`
- Run the `./install-linux.sh` script, it will install everything for you and eventually open the webpage in your browser.
- Follow the install instructions on-page.
Expand All @@ -96,8 +84,8 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
- Some users [have said](https://github.com/Stability-AI/StableSwarmUI/pull/6) that certain Linux distros expect `aspnet-runtime` to be installed separately
- Open a shell terminal and `cd` to a directory you want to install into
- Run shell commands:
- `git clone https://github.com/Stability-AI/StableSwarmUI`
- cd `StableSwarmUI`
- `git clone https://github.com/mcmonkeyprojects/SwarmUI`
- cd `SwarmUI`
- `./launch-linux.sh`
- open `http://localhost:7801/Install` (if it doesn't launch itself)
- Follow the install instructions on-page.
Expand All @@ -106,28 +94,28 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi

# Installing on Mac

> **Note**: You can only run StableSwarmUI on Mac computers with M1 or M2 (Mx) Apple silicon processors.
> **Note**: You can only run SwarmUI on Mac computers with M1 or M2 (Mx) Apple silicon processors.
- Open Terminal.
- Ensure your `brew` packages are updated with `brew update`.
- Verify your `brew` installation with `brew doctor`. You should not see any error in the command output.
- Install .NET for macOS: `brew install dotnet`.
- If you don't have Python, install it: `brew install [email protected]` and `brew install virtualenv`
- Change the directory (`cd`) to the folder where you want to install StableSwarmUI.
- Clone the StableSwarmUI GitHub repository: `git clone https://github.com/Stability-AI/StableSwarmUI`.
- `cd StableSwarmUI` and run the installation script: `./launch-macos.sh`.
- Change the directory (`cd`) to the folder where you want to install SwarmUI.
- Clone the SwarmUI GitHub repository: `git clone https://github.com/mcmonkeyprojects/SwarmUI`.
- `cd eSwarmUI` and run the installation script: `./launch-macos.sh`.

The installation starts now and downloads the Stable Diffusion models from the internet. Depending on your internet connection, this may take several minutes. Wait for your web browser to open the StableSwarmUI window.
The installation starts now and downloads the Stable Diffusion models from the internet. Depending on your internet connection, this may take several minutes. Wait for your web browser to open the SwarmUI window.

> During the StableSwarmUI installation, you are prompted for the type of backend you want to use. For Mac computers with M1 or M2, you can safely choose the ComfyUI backend and choose the Stable Diffusion XL Base and Refiner models in the Download Models screen.
> During the SwarmUI installation, you are prompted for the type of backend you want to use. For Mac computers with M1 or M2, you can safely choose the ComfyUI backend and choose the Stable Diffusion XL Base and Refiner models in the Download Models screen.
# Running with Docker

- To forward an Nvidia GPU, you must have the Nvidia Container Toolkit installed: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
- Open a shell terminal and `cd` to a directory you want to install into
- Run shell commands:
- `git clone https://github.com/Stability-AI/StableSwarmUI`
- cd `StableSwarmUI`
- `git clone https://github.com/mcmonkeyprojects/SwarmUI`
- cd `SwarmUI`
- `./launch-docker.sh`
- Open your browser to `localhost:7801`
- Note that it will forward the `Models` and `Output` directory, and will mount `Data` and `dlbackend` as independent persistent volumes.
Expand All @@ -140,7 +128,7 @@ See [the documentation folder](/docs/README.md).

The "Swarm" name is in reference to the original key function of the UI: enabling a 'swarm' of GPUs to all generate images for the same user at once (especially for large grid generations). This is just the feature that inspired the name and not the end all of what Swarm is.

The overall goal of StableSwarmUI is to a be full-featured one-stop-shop for all things Stable Diffusion.
The overall goal of SwarmUI is to a be full-featured one-stop-shop for all things Stable Diffusion.

See [the motivations document](/docs/Motivations.md) for motivations on technical choices.

Expand All @@ -161,13 +149,20 @@ This project:
- has the option to connect to remote servers to use [the Stability AI API](https://platform.stability.ai/) as a backend.
- supports user-built extensions which may have their own licenses or legal conditions.

StableSwarmUI itself is under the MIT license, however some usages may be affected by the GPL variant licenses of connected projects list above, and note that any models used have their own licenses.
SwarmUI itself is under the MIT license, however some usages may be affected by the GPL variant licenses of connected projects list above, and note that any models used have their own licenses.

### Previous License

(For updates prior to June 2024)

The MIT License (MIT)
Copyright (c) 2024 Stability AI

### License

The MIT License (MIT)

Copyright (c) 2024 Stability AI
Copyright (c) 2024 Alex "mcmonkey" Goodwin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion StableSwarmUI.sln → SwarmUI.sln
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.5.33530.505
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StableSwarmUI", "src\StableSwarmUI.csproj", "{2A621042-196A-4F9C-88EA-10369EAEE774}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SwarmUI", "src\SwarmUI.csproj", "{2A621042-196A-4F9C-88EA-10369EAEE774}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
8 changes: 4 additions & 4 deletions colab/colab-notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"SWARMPATH = '/content/drive/MyDrive'\n",
"\n",
"# Colab breaks venvs, and doesn't save anything valid to drive, so just screw it do a global install of pip reqs if we used a comfy backend in the drive\n",
"!if [[ -f \"$SWARMPATH/StableSwarmUI/dlbackend/ComfyUI/requirements.txt\" ]]; then rm -rf $SWARMPATH/StableSwarmUI/dlbackend/ComfyUI/venv/; pip install -r $SWARMPATH/StableSwarmUI/dlbackend/ComfyUI/requirements.txt; fi"
"!if [[ -f \"$SWARMPATH/SwarmUI/dlbackend/ComfyUI/requirements.txt\" ]]; then rm -rf $SWARMPATH/SwarmUI/dlbackend/ComfyUI/venv/; pip install -r $SWARMPATH/SwarmUI/dlbackend/ComfyUI/requirements.txt; fi"
]
},
{
Expand Down Expand Up @@ -51,8 +51,8 @@
"# Colab breaks venv, so, tell swarm to not make a venv\n",
"os.environ['SWARM_NO_VENV'] = 'true'\n",
"\n",
"# Download StableSwarmUI\n",
"url = \"https://github.com/Stability\" + \"-AI/StableSwarmUI\"\n",
"# Download SwarmUI\n",
"url = \"https://github.com/mcmonkeyprojects/SwarmUI\"\n",
"!git clone $url"
]
},
Expand All @@ -65,7 +65,7 @@
"outputs": [],
"source": [
"# Alright, launch it! Watch the output for a Cloudflare URL\n",
"%cd $SWARMPATH/StableSwarmUI/\n",
"%cd $SWARMPATH/SwarmUI/\n",
"!git pull\n",
"\n",
"!bash ./launch-linux.sh --launch_mode none --cloudflared-path cloudflared"
Expand Down
6 changes: 3 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
services:
stableswarmui:
image: stableswarmui
swarmui:
image: swarmui
build: .
container_name: stableswarmui
container_name: swarmui
# uncomment `networks: host` if you want to access other services on the host network (eg a separated comfy instance)
# networks: host
volumes:
Expand Down
4 changes: 2 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# StableSwarmUI API Documentation
# SwarmUI API Documentation

StableSwarmUI has a full-capability network API that you can use from external programs, both to use Swarm features (eg generate images) and to manage the Swarm instance (eg modify backends).
SwarmUI has a full-capability network API that you can use from external programs, both to use Swarm features (eg generate images) and to manage the Swarm instance (eg modify backends).

Swarm uses its own API - you can simply open the web interface, open your browser tools, and interact with Swarm to watch what API calls are made, and then replicate those from your own code.

Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/AdminAPI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - AdminAPI
# SwarmUI API Documentation - AdminAPI

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/BackendAPI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - BackendAPI
# SwarmUI API Documentation - BackendAPI

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/BasicAPIFeatures.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - BasicAPIFeatures
# SwarmUI API Documentation - BasicAPIFeatures

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/ComfyUIWebAPI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - ComfyUIWebAPI
# SwarmUI API Documentation - ComfyUIWebAPI

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/GridGeneratorExtension.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - GridGeneratorExtension
# SwarmUI API Documentation - GridGeneratorExtension

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/ImageBatchToolExtension.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - ImageBatchToolExtension
# SwarmUI API Documentation - ImageBatchToolExtension

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/ModelsAPI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - ModelsAPI
# SwarmUI API Documentation - ModelsAPI

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/T2IAPI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - T2IAPI
# SwarmUI API Documentation - T2IAPI

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
2 changes: 1 addition & 1 deletion docs/APIRoutes/UtilAPI.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StableSwarmUI API Documentation - UtilAPI
# SwarmUI API Documentation - UtilAPI

> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
Expand Down
14 changes: 7 additions & 7 deletions docs/Advanced Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

(TODO: More examples of advanced usage with explanation)

# Accessing StableSwarmUI From Other Devices
# Accessing SwarmUI From Other Devices

- To access StableSwarmUI from another device over LAN:
- Simply open StableSwarmUI to the `Server` -> `Server Configuration` tab, find `Host` (default value is `localhost`) and change the value to `0.0.0.0`, then save and restart
- Note you may also need to allow StableSwarmUI through your firewall.
- To access StableSwarmUI over open internet without port forwarding:
- To access SwarmUI from another device over LAN:
- Simply open SwarmUI to the `Server` -> `Server Configuration` tab, find `Host` (default value is `localhost`) and change the value to `0.0.0.0`, then save and restart
- Note you may also need to allow SwarmUI through your firewall.
- To access SwarmUI over open internet without port forwarding:
- You can either launch use Cloudflared or Ngrok
- For **Cloudflared:** Install Cloudflared according to [their readme](https://github.com/cloudflare/cloudflared?tab=readme-ov-file#installing-cloudflared) (note: ignore the stuff about accounts/domains/whatever, only the `cloudflared` software install is relevant), and launch StableSwarmUI with `--cloudflared-path [...]` or set the path in Server Configuration `CloudflaredPath` option and restart
- For **Cloudflared:** Install Cloudflared according to [their readme](https://github.com/cloudflare/cloudflared?tab=readme-ov-file#installing-cloudflared) (note: ignore the stuff about accounts/domains/whatever, only the `cloudflared` software install is relevant), and launch SwarmUI with `--cloudflared-path [...]` or set the path in Server Configuration `CloudflaredPath` option and restart
- For Debian Linux servers, look at how the [Colab Notebook](/colab/colab-notebook.ipynb) installs and uses cloudflared.
- For **ngrok:** Install ngrok according to [their documentation](https://ngrok.com/) and login to your ngrok account, and launch StableSwarmUI with `--ngrok-path [...]`
- For **ngrok:** Install ngrok according to [their documentation](https://ngrok.com/) and login to your ngrok account, and launch SwarmUI with `--ngrok-path [...]`

## Custom Workflows (ComfyUI)

Expand Down
Loading

0 comments on commit cc9943c

Please sign in to comment.