Installation and Setup Guide for sd-webui-infinite-image-browsing

This guide provides detailed instructions on how to install and set up the "sd-webui-infinite-image-browsing" application using various methods.

1. As an Extension for Stable Diffusion Web UI

This is the recommended method if you are already using the Stable Diffusion web UI.

1. Open Extensions Tab: Launch your Stable Diffusion web UI and navigate to the Extensions tab.
2. Install from URL: Select the Install from URL option.
3. Enter Repository URL: In the provided input field, enter the repository URL: https://github.com/zanllp/sd-webui-infinite-image-browsing
4. Install: Click on the Install button.
5. Apply and Restart: Wait for the installation to complete, then click on Apply and restart UI. The extension will now be available as a new tab in your Stable Diffusion web UI.

2. As a Standalone Python Program

You can run "Infinite Image Browsing" as a standalone application using Python, without needing the Stable Diffusion web UI.

Prerequisites

• Python (3.x recommended)
• pip (Python package installer)

Installation Steps

1. Clone the Repository: If you haven't already, clone the project repository:

2. Install Dependencies: The project includes a requirements.txt file.
   • Note on Optional Dependencies: hnswlib and numpy are optional but required for experimental features like "natural language categorization & search". If you encounter installation issues for these, you can try:
     Alternatively, to skip optional dependencies during installation, set the environment variable IIB_SKIP_OPTIONAL_DEPS=1 before running pip install.

Running the Application

To run the application, execute app.py:

Common Options:

• --host <address>: Specify the host address (default: 127.0.0.1).
• --port <port>: Specify the port number (default: 8000).
• --sd_webui_config <path>: Path to your Stable Diffusion web UI config.json file. This allows IIB to read your web UI's configured image directories.
• --sd_webui_path_relative_to_config: Use the sd_webui_config file's directory as the base for relative paths specified within config.json.
• --sd_webui_dir <path>: Path to the root of your SD-webui folder. This will automatically set sd_webui_config and sd_webui_path_relative_to_config.
• --extra_paths <path1> <path2> ...: Add additional folders to be browsed. These paths will be added to the homepage but their images won't be indexed for search by default.
• --update_image_index: Update the image index on startup. This is crucial for search functionality.
• --generate_video_cover: Pre-generate video cover images to speed up browsing.
• --generate_image_cache: Pre-generate image cache (thumbnails) to speed up browsing.
• --generate_image_cache_size <size>: Specify the thumbnail size for generate_image_cache (default: 512x512).
• --gen_cache_verbose: Enable verbose output during cache generation.
• --allow_cors: Allow Cross-Origin Resource Sharing (CORS) for the API.
• --enable_shutdown: Enable the /shutdown API endpoint (primarily for Tauri integration).
• --export_fe_fn: Export front-end functions to enable external access through iframe.
• --base <url_path>: The base URL for the IIB API (e.g., /my_iib_app).

Example Usage:

Viewing Images from Other AI Software (ComfyUI/Fooocus/NovelAI/StableSwarmUI/Invoke.AI): The application supports parsing metadata from images generated by these tools. For detailed configuration or troubleshooting, refer to GitHub Issue 202↗.

Docker Usage: For Docker configurations, you can refer to the discussions on GitHub Discussions 366↗.

3. As a Desktop Application

A pre-compiled desktop application version is available for easier installation without Python dependencies. This version also supports ComfyUI/Fooocus/NovelAI.

1. Download Installer: Go to the releases section on the right-hand side of the GitHub repository page↗.
2. Install: Download and install the program for your operating system.
   • Antivirus Warning: Your antivirus software might flag the executable as a false positive. This can typically be ignored. The PyInstaller compiled version often has a lower false positive rate.
3. Self-Compilation: If you prefer to compile it yourself, refer to the workflow definition: .github/workflows/tauri_app_build.yml↗.

4. As a Library (Iframe Usage)

"Infinite Image Browsing" can be embedded into other web applications using an iframe. This allows it to function as a file browser within your existing application.

• For detailed instructions and examples on using IIB via an iframe, refer to: vue/usage.md↗.