InvokeAI/docs/features/WEB.md

76 lines
3.6 KiB
Markdown
Raw Normal View History

Mkdocs-material (#575) * Squashed commit of the following: commit 82d9c25d9a87ea5f6fbdb0445313e48cd8ae3035 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:29:11 2022 +0200 fix branch name in mkdocs-flow commit 2e276cecc1942050ae8b22f4a417c576c49763a1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:28:35 2022 +0200 fix theme name commit 2eb77c1173598e161e8a5a9812b021b831363183 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:14:42 2022 +0200 fixed some links and formating in main README commit 66a7152e48e8c66c9286f47a6b088920a8fcdcd8 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 08:58:58 2022 +0200 trigger mkdocs deployment on main commit 897cc373ce4f9d18d8cb2837b5931c4b674c836b Merge: 89da371 3b5a830 Author: Matthias Wild <40327258+mauwii@users.noreply.github.com> Date: Wed Sep 14 07:51:23 2022 +0200 Merge pull request #1 from mauwii/mkdocs Mkdocs commit 3b5a8308eb6b7ee572ff07f78829f64bcf55b4d9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:42:56 2022 +0200 huge update I was pretty busy trying to make the Readmes / docs look good in MkDocs commit 0b4f5a926ff8aad1460e0be8093ee02d719a576d Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:41:45 2022 +0200 update mkdocs config commit 872172ea7008aa1217c1259c7ecab16ddafd1a0e Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:33:49 2022 +0200 added the mkdocs-git-revision-date-plugin commit eac81bf87588ec88b65f3415aa838c330fbd621b Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 06:46:43 2022 +0200 add prettier config remove markdownlint move and rename requirements-mkdocs.txt commit b36d4cc088a49af56026aa2dd2e85d6bfb181bd1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 02:06:39 2022 +0200 add dark theme commit a14f18fede6febccf1c117cba50a1aff1eac80a9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:38:02 2022 +0200 update mkdocs flow and config commit 2764b48693ed382bc01a2cb7aab282dbf95cd9ee Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:15:33 2022 +0200 add mkdocs workflow commit 1bd22523b1a52ac24bc5f950debb450f903c2d51 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 00:57:37 2022 +0200 I already begun with formating / revising the sites * change repository in mkdocs config to lstein * adapt changes from repos main README.md Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-15 14:53:41 +00:00
---
2022-10-06 19:27:47 +00:00
title: InvokeAI Web UI & Server
Mkdocs-material (#575) * Squashed commit of the following: commit 82d9c25d9a87ea5f6fbdb0445313e48cd8ae3035 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:29:11 2022 +0200 fix branch name in mkdocs-flow commit 2e276cecc1942050ae8b22f4a417c576c49763a1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:28:35 2022 +0200 fix theme name commit 2eb77c1173598e161e8a5a9812b021b831363183 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:14:42 2022 +0200 fixed some links and formating in main README commit 66a7152e48e8c66c9286f47a6b088920a8fcdcd8 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 08:58:58 2022 +0200 trigger mkdocs deployment on main commit 897cc373ce4f9d18d8cb2837b5931c4b674c836b Merge: 89da371 3b5a830 Author: Matthias Wild <40327258+mauwii@users.noreply.github.com> Date: Wed Sep 14 07:51:23 2022 +0200 Merge pull request #1 from mauwii/mkdocs Mkdocs commit 3b5a8308eb6b7ee572ff07f78829f64bcf55b4d9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:42:56 2022 +0200 huge update I was pretty busy trying to make the Readmes / docs look good in MkDocs commit 0b4f5a926ff8aad1460e0be8093ee02d719a576d Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:41:45 2022 +0200 update mkdocs config commit 872172ea7008aa1217c1259c7ecab16ddafd1a0e Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:33:49 2022 +0200 added the mkdocs-git-revision-date-plugin commit eac81bf87588ec88b65f3415aa838c330fbd621b Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 06:46:43 2022 +0200 add prettier config remove markdownlint move and rename requirements-mkdocs.txt commit b36d4cc088a49af56026aa2dd2e85d6bfb181bd1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 02:06:39 2022 +0200 add dark theme commit a14f18fede6febccf1c117cba50a1aff1eac80a9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:38:02 2022 +0200 update mkdocs flow and config commit 2764b48693ed382bc01a2cb7aab282dbf95cd9ee Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:15:33 2022 +0200 add mkdocs workflow commit 1bd22523b1a52ac24bc5f950debb450f903c2d51 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 00:57:37 2022 +0200 I already begun with formating / revising the sites * change repository in mkdocs config to lstein * adapt changes from repos main README.md Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-15 14:53:41 +00:00
---
2022-10-06 19:27:47 +00:00
# :material-web: InvokeAI Web Server
2022-09-18 19:30:18 +00:00
2022-10-06 19:27:47 +00:00
As of version 2.0, this distribution's web server has been updated to include
an all-new UI, with optimizations to improve common workflows for image generation.
## Getting Started & Initialization Commands
To start the web server, run the `dream.py` script by adding the `--web` parameter.
Mkdocs-material (#575) * Squashed commit of the following: commit 82d9c25d9a87ea5f6fbdb0445313e48cd8ae3035 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:29:11 2022 +0200 fix branch name in mkdocs-flow commit 2e276cecc1942050ae8b22f4a417c576c49763a1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:28:35 2022 +0200 fix theme name commit 2eb77c1173598e161e8a5a9812b021b831363183 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:14:42 2022 +0200 fixed some links and formating in main README commit 66a7152e48e8c66c9286f47a6b088920a8fcdcd8 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 08:58:58 2022 +0200 trigger mkdocs deployment on main commit 897cc373ce4f9d18d8cb2837b5931c4b674c836b Merge: 89da371 3b5a830 Author: Matthias Wild <40327258+mauwii@users.noreply.github.com> Date: Wed Sep 14 07:51:23 2022 +0200 Merge pull request #1 from mauwii/mkdocs Mkdocs commit 3b5a8308eb6b7ee572ff07f78829f64bcf55b4d9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:42:56 2022 +0200 huge update I was pretty busy trying to make the Readmes / docs look good in MkDocs commit 0b4f5a926ff8aad1460e0be8093ee02d719a576d Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:41:45 2022 +0200 update mkdocs config commit 872172ea7008aa1217c1259c7ecab16ddafd1a0e Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:33:49 2022 +0200 added the mkdocs-git-revision-date-plugin commit eac81bf87588ec88b65f3415aa838c330fbd621b Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 06:46:43 2022 +0200 add prettier config remove markdownlint move and rename requirements-mkdocs.txt commit b36d4cc088a49af56026aa2dd2e85d6bfb181bd1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 02:06:39 2022 +0200 add dark theme commit a14f18fede6febccf1c117cba50a1aff1eac80a9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:38:02 2022 +0200 update mkdocs flow and config commit 2764b48693ed382bc01a2cb7aab282dbf95cd9ee Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:15:33 2022 +0200 add mkdocs workflow commit 1bd22523b1a52ac24bc5f950debb450f903c2d51 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 00:57:37 2022 +0200 I already begun with formating / revising the sites * change repository in mkdocs config to lstein * adapt changes from repos main README.md Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-15 14:53:41 +00:00
```bash
(ldm) ~/stable-diffusion$ python3 scripts/dream.py --web
```
Mkdocs-material (#575) * Squashed commit of the following: commit 82d9c25d9a87ea5f6fbdb0445313e48cd8ae3035 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:29:11 2022 +0200 fix branch name in mkdocs-flow commit 2e276cecc1942050ae8b22f4a417c576c49763a1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:28:35 2022 +0200 fix theme name commit 2eb77c1173598e161e8a5a9812b021b831363183 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 19:14:42 2022 +0200 fixed some links and formating in main README commit 66a7152e48e8c66c9286f47a6b088920a8fcdcd8 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 08:58:58 2022 +0200 trigger mkdocs deployment on main commit 897cc373ce4f9d18d8cb2837b5931c4b674c836b Merge: 89da371 3b5a830 Author: Matthias Wild <40327258+mauwii@users.noreply.github.com> Date: Wed Sep 14 07:51:23 2022 +0200 Merge pull request #1 from mauwii/mkdocs Mkdocs commit 3b5a8308eb6b7ee572ff07f78829f64bcf55b4d9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:42:56 2022 +0200 huge update I was pretty busy trying to make the Readmes / docs look good in MkDocs commit 0b4f5a926ff8aad1460e0be8093ee02d719a576d Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:41:45 2022 +0200 update mkdocs config commit 872172ea7008aa1217c1259c7ecab16ddafd1a0e Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 07:33:49 2022 +0200 added the mkdocs-git-revision-date-plugin commit eac81bf87588ec88b65f3415aa838c330fbd621b Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 06:46:43 2022 +0200 add prettier config remove markdownlint move and rename requirements-mkdocs.txt commit b36d4cc088a49af56026aa2dd2e85d6bfb181bd1 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 02:06:39 2022 +0200 add dark theme commit a14f18fede6febccf1c117cba50a1aff1eac80a9 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:38:02 2022 +0200 update mkdocs flow and config commit 2764b48693ed382bc01a2cb7aab282dbf95cd9ee Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 01:15:33 2022 +0200 add mkdocs workflow commit 1bd22523b1a52ac24bc5f950debb450f903c2d51 Author: mauwii <Mauwii@outlook.de> Date: Wed Sep 14 00:57:37 2022 +0200 I already begun with formating / revising the sites * change repository in mkdocs config to lstein * adapt changes from repos main README.md Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
2022-09-15 14:53:41 +00:00
You can then connect to the server by pointing your web browser at
http://localhost:9090, or to the network name or IP address of the server.
2022-10-06 19:27:47 +00:00
### Additional Options
`--web_develop` - Starts the web server in development mode.
`--web_verbose` - Enables verbose logging
`--cors [CORS ...]` - Additional allowed origins, comma-separated
`--host HOST` - Web server: Host or IP to listen on. Set to 0.0.0.0 to
accept traffic from other devices on your network.
`--port PORT` - Web server: Port to listen on
`--gui` - Start InvokeAI GUI - This is the "desktop mode" version of the web app. It uses Flask
to create a desktop app experience of the webserver.
## Web Specific Features
The web experience offers an incredibly easy-to-use experience for interacting with the InvokeAI toolkit.
For detailed guidance on individual features, see the Feature-specific help documents available in this directory.
Note that the latest functionality available in the CLI may not always be available in the Web interface.
### Dark Mode & Light Mode
The InvokeAI interface is available in a nano-carbon black & purple Dark Mode, and a "burn your eyes out Nosferatu" Light Mode. These can be toggled by clicking the Sun/Moon icons at the top right of the interface.
![InvokeAI Web Server - Dark Mode](../assets/invoke_web_dark.png)
![InvokeAI Web Server - Light Mode](../assets/invoke_web_light.png)
### Invocation Toolbar
The left side of the InvokeAI interface is available for customizing the prompt and the settings used for invoking your new image. Typing your prompt into the open text field and clicking the Invoke button will produce the image based on the settings configured in the toolbar.
See below for additional documentation related to each feature:
- [Core Prompt Settings](./CLI.md)
- [Variations](./VARIATIONS.md)
- [Upscaling](./UPSCALE.md)
- [Image to Image](./IMG2IMG.md)
- [Inpainting](./INPAINTING.md)
- [Other](./OTHER.md)
### Invocation Gallery
The currently selected --outdir (or the default outputs folder) will display all previously generated files on load. As new invocations are generated, these will be dynamically added to the gallery, and can be previewed by selecting them. Each image also has a simple set of actions (e.g., Delete, Use Seed, Use All Parameters, etc.) that can be accessed by hovering over the image.
### Image Workspace
When an image from the Invocation Gallery is selected, or is generated, the image will be displayed within the center of the interface. A quickbar of common image interactions are displayed along the top of the image, including:
- Use image in the `Image to Image` workflow
- Initialize Face Restoration on the selected file
- Initialize Upscaling on the selected file
- View File metadata and details
- Delete the file
## Acknowledgements
A huge shout-out to the core team working to make this vision a reality, including [psychedelicious](https://github.com/psychedelicious), [Kyle0654](https://github.com/Kyle0654) and [blessedcoolant](https://github.com/blessedcoolant). [hipsterusername](https://github.com/hipsterusername) was the team's unofficial cheerleader and added tooltips/docs.