Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/entelecheia/invokeai-container
A prebuilt Docker images to easily run InvokeAI for AI-assisted art generation and creative workflows.
https://github.com/entelecheia/invokeai-container
Last synced: 17 days ago
JSON representation
A prebuilt Docker images to easily run InvokeAI for AI-assisted art generation and creative workflows.
- Host: GitHub
- URL: https://github.com/entelecheia/invokeai-container
- Owner: entelecheia
- License: mit
- Created: 2023-09-02T03:25:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-14T18:39:05.000Z (3 months ago)
- Last Synced: 2024-08-14T20:17:38.994Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 133 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Invoke AI Container - Generative AI for Professional Creatives
[![version-image]][release-url]
[![release-date-image]][release-url]
[![license-image]][license-url]
A prebuilt Docker images to easily run [InvokeAI](https://github.com/invoke-ai/InvokeAI) for AI-assisted art generation and creative workflows.
- GitHub: [https://github.com/entelecheia/invokeai-container][repo-url]
invokeai-container offers prebuilt Docker images to quickly run InvokeAI using Docker with no installation required. It includes images for both CPU and GPU inference. The images come preinstalled with InvokeAI and all its dependencies. They allow you to instantly start using InvokeAI for tasks like text-to-image generation, image upscaling, inpainting, outpainting, etc.
## Prerequisites
- Docker
- Docker Compose
- NVIDIA Docker (for GPU support, Optional)
## Build and Run
1. Build the base Docker image:
```bash
make docker-build-base
```
The base Docker image are used to build other Docker images. It installs all the dependencies required by the project.
The `docker.base.env` file includes various configuration options and environment variables. The `docker-compose.base.yaml` file uses these variables to customize the behavior of the services. This is a common practice when you want to set different configurations for development, testing, and production environments. The `Dockerfile.base` file uses these variables to customize the Docker build. These files are automatically generated by Copier when you run the `copier copy` command.
2. Build the application Docker image:
You should build the application Docker image by yourself to make sure that the user id mapping is correct for your host system.
```bash
make docker-build-app
```
The application Docker image is used to run the application. It installs the application and its dependencies.
The `docker.app.env` file includes various configuration options and environment variables. The `docker-compose.app.yaml` file uses these variables to customize the behavior of the services. This is a common practice when you want to set different configurations for development, testing, and production environments. The `Dockerfile.app` file uses these variables to customize the Docker build. These files are automatically generated by Copier when you run the `copier copy` command.
3. Configure the application Docker image:
Configure InvokeAI and install a starting set of image generation models (you only need to do this once):
```bash
make docker-configure-app
```
4. Start the Docker container:
```bash
make docker-up-app
```
This will start a Docker container with the image built in the previous step. The container will run a bash lauch script that starts the application.
## Usage
After starting the container, you can access the application at `localhost:`. By default, the port is set to `19092`.
You can also SSH into the container using the SSH port specified in `APP_HOST_SSH_PORT`. By default, the port is set to `2222`.
## Volumes
The `docker-compose.app.yaml` file specifies several volumes that bind mount directories on the host to directories in the container. These include the cache, the workspace directory, and the scripts directory. Changes made in these directories will persist across container restarts.
## Troubleshooting
If you encounter any issues with this setup, please check the following:
- Make sure Docker and Docker Compose are installed correctly.
- Make sure NVIDIA Docker is installed if you're planning to use GPU acceleration.
- Ensure the environment variables in the `docker.app.env` file are correctly set.
- Check the Docker and Docker Compose logs for any error messages.
## Environment Variables
In Docker, environment variables can be used in the `docker-compose.app.yaml` file to customize the behavior of the services.
The `docker-compose` command has an `--env-file` argument, but it's used to set the environment variables for the services defined in the `docker-compose.yaml` file, not for the `docker-compose` command itself. The variables defined in the `--env-file` will not be substituted into the `docker-compose.yaml` file.
However, the environment variables we set in the `.docker/docker.app.env` file are used in the `docker-compose.app.yaml` file. For example, the `$BUILD_FROM` variable is used to set the base image for the Docker build. Therefore, we need to export these variables to the shell environment before running the `docker-compose` command.
This method also allows us to use shell commands in the variable definitions, like `"$(whoami)"` for the `USERNAME` variable, which wouldn't be possible if we used the `--env-file` argument. Shell commands in the `.env` file are not evaluated.
### Files for Environment Variables
- `.docker/docker.common.env`: Common environment variables for all Docker images.
- `.docker/docker.base.env`: Environment variables for the base Docker image.
- `.docker/docker.app.env`: Environment variables for the application Docker image.
- `.env.secret`: Secret environment variables that are not committed to the repository.
## Changelog
See the [CHANGELOG] for more information.
## Contributing
Contributions are welcome! Please see the [contributing guidelines] for more information.
## License
This project is released under the [MIT License][license-url].
[license-image]: https://img.shields.io/github/license/entelecheia/invokeai-container
[license-url]: https://github.com/entelecheia/invokeai-container/blob/main/LICENSE
[version-image]: https://img.shields.io/github/v/release/entelecheia/invokeai-container?sort=semver
[release-date-image]: https://img.shields.io/github/release-date/entelecheia/invokeai-container
[release-url]: https://github.com/entelecheia/invokeai-container/releases
[repo-url]: https://github.com/entelecheia/invokeai-container
[changelog]: https://github.com/entelecheia/invokeai-container/blob/main/CHANGELOG.md
[contributing guidelines]: https://github.com/entelecheia/invokeai-container/blob/main/CONTRIBUTING.md