From 10ef27065b9d4093ead2877ba2d558e25dfd1c6b Mon Sep 17 00:00:00 2001 From: Micah Zoltu Date: Thu, 20 Mar 2025 21:37:48 +0800 Subject: [PATCH] Improves documentation around docker usage. --- Dockerfile | 5 +++++ README.md | 7 +++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 021669c..03cc9c1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -23,4 +23,9 @@ RUN git clone https://github.com/SWivid/F5-TTS.git \ ENV SHELL=/bin/bash +# models are downloaded into this folder, so user should mount it +VOLUME /root/.cache/huggingface/hub/ +# port the GUI is exposed on by default, if it is run +EXPOSE 7860 + WORKDIR /workspace/F5-TTS diff --git a/README.md b/README.md index cb5e671..dea4b79 100644 --- a/README.md +++ b/README.md @@ -100,8 +100,11 @@ conda activate f5-tts # Build from Dockerfile docker build -t f5tts:v1 . -# Or pull from GitHub Container Registry -docker pull ghcr.io/swivid/f5-tts:main +# Run from GitHub Container Registry +docker container run --rm -it --gpus=all --mount 'type=volume,source=f5-tts,target=/root/.cache/huggingface/hub/' -p 7860:7860 ghcr.io/swivid/f5-tts:main + +# Quickstart if you want to just run the web interface (not CLI) +docker container run --rm -it --gpus=all --mount 'type=volume,source=f5-tts,target=/root/.cache/huggingface/hub/' -p 7860:7860 ghcr.io/swivid/f5-tts:main f5-tts_infer-gradio --host 0.0.0.0 ```