diff --git a/invokeai/README.md b/invokeai/README.md index 94cc513..78f0075 100644 --- a/invokeai/README.md +++ b/invokeai/README.md @@ -1,46 +1,21 @@ -# Project Name +# Invokeai ## Overview -A short 1--3 sentence description of what this Docker Compose project -does. +Makes images, needs gpu. ## Project Details -- **Project Repository:** [Link](https://example.com) -- **Container Image:** [Docker Hub](https://dockerhub.com) -- **Compose Example:** [Compose](https://dockerhub.com) -- **Documentation:** [Docs](https://dockerhub.com) -- **Reverse Proxy Port:** `80` - -## Environment Variable Notes - -List any required or optional environment variables, where they come -from, and how they are used. - -Example: - - VAR_NAME – explanation of purpose - ANOTHER_VAR – where to get the value - -## Volume Notes - -Describe important volumes, what they store, and whether they need -manual creation or backups. - -Example: - - /data – persistent application storage - /config – configuration files - -## Network Notes - -Requires proxy network +- **Project Repository:** [Github](https://github.com/invoke-ai/InvokeAI/tree/main) +- **Container Image:** ghcr.io/invoke-ai/invokeai +- **Documentation:** [Docs](https://invoke-ai.github.io/InvokeAI/) +- **Reverse Proxy Port:** You Can set this in env, I have it set to 9090 ## Additional Notes / Gotchas -Add any special information someone should know before running the -project---quirks, caveats, network requirements, etc. +To get started, go to the models tab and install: RealVisXL V3 or Juggernaut XL +Also in the model manager, for upscale install: RealESRGAN_x4plus +And last install Tile SDXL version ## Dockhand Stack, Deploy from Git