From 4155aaa96ae14f1d2aec75278257df7778d5274e Mon Sep 17 00:00:00 2001 From: Atinoda <61033436+Atinoda@users.noreply.github.com> Date: Wed, 24 May 2023 00:35:53 +0100 Subject: [PATCH] Add mention to alternative docker repository (#2145) --- README.md | 5 ++-- docs/Docker.md | 74 ++++++++++++++++++++++++++++++++------------------ 2 files changed, 50 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 8403d824..0a93def9 100644 --- a/README.md +++ b/README.md @@ -118,9 +118,8 @@ cp docker/.env.example .env docker compose up --build ``` -You need to have docker compose v2.17 or higher installed in your system. To see how to install docker compose itself, see the guide in [here](https://github.com/oobabooga/text-generation-webui/blob/main/docs/Docker.md). - -Contributed by [@loeken](https://github.com/loeken) in [#633](https://github.com/oobabooga/text-generation-webui/pull/633) +* You need to have docker compose v2.17 or higher installed. See [this guide](https://github.com/oobabooga/text-generation-webui/blob/main/docs/Docker.md) for instructions. +* For additional docker files, check out [this repository](https://github.com/Atinoda/text-generation-webui/blob/docker-wrapper/docs/Docker.md#dedicated-docker-repository). ### Updating the requirements diff --git a/docs/Docker.md b/docs/Docker.md index b1e92253..322dba39 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -7,7 +7,24 @@ In order to create the image as described in the main README, you must have dock Docker Compose version v2.17.2 ``` -# Intructions by [@loeken](https://github.com/loeken) +Make sure to also create the necessary symbolic links: + +``` +cd text-generation-webui +ln -s docker/{Dockerfile,docker-compose.yml,.dockerignore} . +cp docker/.env.example .env +# Edit .env and set TORCH_CUDA_ARCH_LIST based on your GPU model +docker compose up --build +``` + +# Table of contents + +* [Docker Compose installation instructions](#docker-compose-installation-instructions) +* [Repository with additional Docker files](#dedicated-docker-repository) + +# Docker Compose installation instructions + +By [@loeken](https://github.com/loeken). - [Ubuntu 22.04](#ubuntu-2204) - [0. youtube video](#0-youtube-video) @@ -35,21 +52,21 @@ Docker Compose version v2.17.2 - [7. startup](#7-startup) - [notes](#notes) -# Ubuntu 22.04 +## Ubuntu 22.04 -## 0. youtube video +### 0. youtube video A video walking you through the setup can be found here: [![oobabooga text-generation-webui setup in docker on ubuntu 22.04](https://img.youtube.com/vi/ELkKWYh8qOk/0.jpg)](https://www.youtube.com/watch?v=ELkKWYh8qOk) -## 1. update the drivers +### 1. update the drivers in the the “software updater” update drivers to the last version of the prop driver. -## 2. reboot +### 2. reboot to switch using to new driver -## 3. install docker +### 3. install docker ```bash sudo apt update sudo apt-get install curl @@ -65,7 +82,7 @@ sudo usermod -aG docker $USER newgrp docker ``` -## 4. docker & container toolkit +### 4. docker & container toolkit ```bash curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://nvidia.github.io/libnvidia-container/stable/ubuntu22.04/amd64 /" | \ @@ -75,13 +92,13 @@ sudo apt install nvidia-docker2 nvidia-container-runtime -y sudo systemctl restart docker ``` -## 5. clone the repo +### 5. clone the repo ``` git clone https://github.com/oobabooga/text-generation-webui cd text-generation-webui ``` -## 6. prepare models +### 6. prepare models download and place the models inside the models folder. tested with: 4bit @@ -91,30 +108,30 @@ https://github.com/oobabooga/text-generation-webui/pull/530#issuecomment-1483941 8bit: https://github.com/oobabooga/text-generation-webui/pull/530#issuecomment-1484235789 -## 7. prepare .env file +### 7. prepare .env file edit .env values to your needs. ```bash cp .env.example .env nano .env ``` -## 8. startup docker container +### 8. startup docker container ```bash docker compose up --build ``` -# Manjaro +## Manjaro manjaro/arch is similar to ubuntu just the dependency installation is more convenient -## update the drivers +### update the drivers ```bash sudo mhwd -a pci nonfree 0300 ``` -## reboot +### reboot ```bash reboot ``` -## docker & container toolkit +### docker & container toolkit ```bash yay -S docker docker-compose buildkit gcc nvidia-docker sudo usermod -aG docker $USER @@ -122,32 +139,32 @@ newgrp docker sudo systemctl restart docker # required by nvidia-container-runtime ``` -## continue with ubuntu task +### continue with ubuntu task continue at [5. clone the repo](#5-clone-the-repo) -# Windows -## 0. youtube video +## Windows +### 0. youtube video A video walking you through the setup can be found here: [![oobabooga text-generation-webui setup in docker on windows 11](https://img.youtube.com/vi/ejH4w5b5kFQ/0.jpg)](https://www.youtube.com/watch?v=ejH4w5b5kFQ) -## 1. choco package manager +### 1. choco package manager install package manager (https://chocolatey.org/ ) ``` Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')) ``` -## 2. install drivers/dependencies +### 2. install drivers/dependencies ``` choco install nvidia-display-driver cuda git docker-desktop ``` -## 3. install wsl +### 3. install wsl wsl --install -## 4. reboot +### 4. reboot after reboot enter username/password in wsl -## 5. git clone && startup +### 5. git clone && startup clone the repo and edit .env values to your needs. ``` cd Desktop @@ -157,19 +174,19 @@ COPY .env.example .env notepad .env ``` -## 6. prepare models +### 6. prepare models download and place the models inside the models folder. tested with: 4bit https://github.com/oobabooga/text-generation-webui/pull/530#issuecomment-1483891617 https://github.com/oobabooga/text-generation-webui/pull/530#issuecomment-1483941105 8bit: https://github.com/oobabooga/text-generation-webui/pull/530#issuecomment-1484235789 -## 7. startup +### 7. startup ``` docker compose up ``` -# notes +## notes on older ubuntus you can manually install the docker compose plugin like this: ``` @@ -179,3 +196,8 @@ curl -SL https://github.com/docker/compose/releases/download/v2.17.2/docker-comp chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose export PATH="$HOME/.docker/cli-plugins:$PATH" ``` + +# Dedicated docker repository + +An external repository maintains a docker wrapper for this project as well as several pre-configured 'one-click' `docker compose` variants (e.g., updated branches of GPTQ). It can be found at: [Atinoda/text-generation-webui-docker](https://github.com/Atinoda/text-generation-webui-docker). +