communitylive avatar
1.0.0
This project provides a web application that generates avatars from headshots captured via webcam or uploaded files. It leverages the img2img functionality of the Stable Diffusion REST API, which is integrated through the Stable Diffusion WebUI.
The project is centered around a Python application (app.py) that exposes a REST API. This API processes an original image along with optional parameters (fantasy level and gender preference) and returns the generated avatar. The following directories and files are included:
.
├── app.py # Main application file exposing REST API
├── static # Static resources for the web application
│ ├── Hyland_logo.png
│ └── style.css
└── templates # HTML templates
└── index.htmlThe Python application is configured to connect to the Stable Diffusion REST API at http://localhost:7861/sdapi/v1/img2img by default. Follow these steps to install and set up the REST API locally:
Clone the Stable Diffusion WebUI Repository
git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui
cd stable-diffusion-webuiDownload a Stable Diffusion Model from Hugging Face
cd models/Stable-diffusion
wget https://huggingface.co/lllyasviel/fav_models/resolve/main/fav/realisticVisionV51_v51VAE.safetensors
cd ../..Create a Virtual Environment
python3 -m venv venv
source venv/bin/activateInstall Dependencies and Start the WebUI
Run the script to install requirements and start the application:
./webui.shOnce the application is running at http://127.0.0.1:7860, you can stop it with Ctrl+C.
Note: This step is required only during the initial setup.
Start the REST API
If you don't have a GPU, you can start the API using the CPU:
python3 launch.py --nowebui --skip-python-version-check --always-cpu --skip-torch-cuda-testThe API will be accessible via your browser at http://localhost:7861/docs#/default/img2imgapi_sdapi_v1_img2img_post.
To test the application locally:
Start the Stable Diffusion REST API and ensure http://localhost:7861/sdapi/v1/img2img is reachable.
Start the Web Application
Set up the Python environment and run the application:
python3 -m venv venv
source venv/bin/activate
pip install flask requests Pillow boto3
python3 app.pyAccess the Web Application
Open a web browser and navigate to http://localhost:5000 to use the avatar generator.
To deploy the application on an AWS EC2 instance, follow the usual process of setting up a server, ensuring that Python 3.10, the Stable Diffusion WebUI, and other dependencies are properly installed. Adjust security groups and instance types based on whether you are using a GPU. Refer to the AWS documentation for detailed instructions.
This guide outlines the steps to deploy the Avatar Generator application on an AWS EC2 instance equipped with a GPU.
g4dn.xlarge
Update System Packages
sudo apt-get update
sudo apt-get upgrade -yVerify NVIDIA Device Presence
sudo lshw -c videoYou should see output indicating the presence of an NVIDIA GPU, such as:
*-display:1
description: 3D controller
product: TU104GL [Tesla T4]
vendor: NVIDIA Corporation
Install NVIDIA Drivers
sudo apt install -y ubuntu-drivers-common
sudo ubuntu-drivers autoinstallReboot the Instance
sudo rebootAfter rebooting, verify the NVIDIA drivers are correctly installed:
nvidia-smiExpected output should show the NVIDIA driver version and CUDA version.
For additional details on installing NVIDIA drivers, refer to Ubuntu's documentation.
Clone the Stable Diffusion WebUI Repository
git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui
cd stable-diffusion-webuiDownload Stable Diffusion Model
cd models/Stable-diffusion
wget https://huggingface.co/lllyasviel/fav_models/resolve/main/fav/realisticVisionV51_v51VAE.safetensors
cd ../..Install Python Package Installer
sudo apt install python3-pipCreate and Activate a Virtual Environment
python3 -m venv venv
source venv/bin/activateInstall Dependencies and Start WebUI
./webui.shYou can stop the application with Ctrl+C after it starts running at http://127.0.0.1:7860.
Start the REST API
python3 launch.py --nowebui --skip-python-version-check --skip-torch-cuda-testCreate a Startup Script for the REST API
Create a script to easily start the API in the future:
$ cat start_api.sh
#!/bin/bash
# Navigate to the stable-diffusion-webui directory
cd stable-diffusion-webui
# Create a virtual environment if it doesn't exist
if [ ! -d "venv" ]; then
python3 -m venv venv
fi
# Activate the virtual environment
source venv/bin/activate
# Launch the application and write output to api.log
python3 launch.py --nowebui --skip-python-version-check --skip-torch-cuda-test > ../api.log 2>&1 &
# Print a message indicating the application has started
echo "API has started. Output is being written to api.log"Clone the Web Application Repository
git clone https://github.com/aborroy/communitylive-avatar.git
cd communitylive-avatarCreate a Virtual Environment and Start the Application
python3 -m venv venv
source venv/bin/activate
pip install flask requests Pillow boto3
python3 app.pyCreate a Startup Script for the Web Application
Create a script to easily start the web application:
$ cat start_app.sh
#!/bin/bash
# Navigate to the app directory
cd communitylive-avatar
# Create a virtual environment if it doesn't exist
if [ ! -d "venv" ]; then
python3 -m venv venv
fi
# Activate the virtual environment
source venv/bin/activate
# Launch the application and write output to app.log
python3 app.py > ../app.log 2>&1 &
# Print a message indicating the application has started
echo "Application has started. Output is being written to app.log"Since the application uses a webcam, a secure HTTPS connection is required. Use AWS Route 53 to route traffic to the EC2 instance. Example DNS: communitylive-avatar.alfdemo.com.
Install NGINX
sudo apt-get install nginxInstall Certbot and NGINX Plugin
sudo apt-get install certbot python3-certbot-nginxConfigure NGINX
Create an NGINX configuration file:
sudo vi /etc/nginx/sites-available/appAdd the following configuration:
server {
listen 80;
server_name communitylive-avatar.alfdemo.com;
client_max_body_size 64M;
location / {
proxy_pass http://127.0.0.1:5000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}Enable the NGINX Configuration
sudo ln -s /etc/nginx/sites-available/app /etc/nginx/sites-enabledTest NGINX Configuration and Reload
sudo nginx -t
sudo systemctl reload nginxObtain an SSL Certificate
sudo certbot --nginx -d communitylive-avatar.alfdemo.comCertbot will automatically configure NGINX to use TLS on port 443.
To enable email delivery of avatars using AWS SES (Simple Email Service), follow these steps:
Install AWS CLI:
Configure AWS CLI:
aws configureSet Up AWS SES:
aws ses verify-email-identity --email-address [email protected]Test SES Email Sending:
aws ses send-email --from [email protected] --destination [email protected] --message "Subject={Data=Test Email},Body={Text={Data=Hello!}}" With AWS SES configured, your application will be able to send the generated avatars via email to the specified recipients.
If all steps are completed successfully, your application will be accessible at https://communitylive-avatar.alfdemo.com.
