105 lines
3.9 KiB
Plaintext
105 lines
3.9 KiB
Plaintext
|
This guide provides a quick start for running different profiles of PrivateGPT using Docker Compose.
|
||
|
|
The profiles cater to various environments, including Ollama setups (CPU, CUDA, MacOS), and a fully local setup.
|
||
|
|
|
||
|
|
By default, Docker Compose will download pre-built images from a remote registry when starting the services. However, you have the option to build the images locally if needed. Details on building Docker image locally are provided at the end of this guide.
|
||
|
|
|
||
|
|
If you want to run PrivateGPT locally without Docker, refer to the [Local Installation Guide](/installation).
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
- **Docker and Docker Compose:** Ensure both are installed on your system.
|
||
|
|
[Installation Guide for Docker](https://docs.docker.com/get-docker/), [Installation Guide for Docker Compose](https://docs.docker.com/compose/install/).
|
||
|
|
- **Clone PrivateGPT Repository:** Clone the PrivateGPT repository to your machine and navigate to the directory:
|
||
|
|
```sh
|
||
|
|
git clone https://github.com/zylon-ai/private-gpt.git
|
||
|
|
cd private-gpt
|
||
|
|
```
|
||
|
|
|
||
|
|
## Setups
|
||
|
|
|
||
|
|
### Ollama Setups (Recommended)
|
||
|
|
|
||
|
|
#### 1. Default/Ollama CPU
|
||
|
|
|
||
|
|
**Description:**
|
||
|
|
This profile runs the Ollama service using CPU resources. It is the standard configuration for running Ollama-based Private-GPT services without GPU acceleration.
|
||
|
|
|
||
|
|
**Run:**
|
||
|
|
To start the services using pre-built images, run:
|
||
|
|
```sh
|
||
|
|
docker-compose up
|
||
|
|
```
|
||
|
|
or with a specific profile:
|
||
|
|
```sh
|
||
|
|
docker-compose --profile ollama-cpu up
|
||
|
|
```
|
||
|
|
|
||
|
|
#### 2. Ollama Nvidia CUDA
|
||
|
|
|
||
|
|
**Description:**
|
||
|
|
This profile leverages GPU acceleration with CUDA support, suitable for computationally intensive tasks that benefit from GPU resources.
|
||
|
|
|
||
|
|
**Requirements:**
|
||
|
|
Ensure that your system has compatible GPU hardware and the necessary NVIDIA drivers installed. The installation process is detailed [here](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html).
|
||
|
|
|
||
|
|
**Run:**
|
||
|
|
To start the services with CUDA support using pre-built images, run:
|
||
|
|
```sh
|
||
|
|
docker-compose --profile ollama-cuda up
|
||
|
|
```
|
||
|
|
|
||
|
|
#### 3. Ollama External API
|
||
|
|
|
||
|
|
**Description:**
|
||
|
|
This profile is designed for running PrivateGPT using Ollama installed on the host machine. This setup is particularly useful for MacOS users, as Docker does not yet support Metal GPU.
|
||
|
|
|
||
|
|
**Requirements:**
|
||
|
|
Install Ollama on your machine by following the instructions at [ollama.ai](https://ollama.ai/).
|
||
|
|
|
||
|
|
**Run:**
|
||
|
|
To start the Ollama service, use:
|
||
|
|
```sh
|
||
|
|
OLLAMA_HOST=0.0.0.0 ollama serve
|
||
|
|
```
|
||
|
|
To start the services with the host configuration using pre-built images, run:
|
||
|
|
```sh
|
||
|
|
docker-compose --profile ollama-api up
|
||
|
|
```
|
||
|
|
|
||
|
|
### Fully Local Setups
|
||
|
|
|
||
|
|
#### 1. LlamaCPP CPU
|
||
|
|
|
||
|
|
**Description:**
|
||
|
|
This profile runs the Private-GPT services locally using `llama-cpp` and Hugging Face models.
|
||
|
|
|
||
|
|
**Requirements:**
|
||
|
|
A **Hugging Face Token (HF_TOKEN)** is required for accessing Hugging Face models. Obtain your token following [this guide](/installation/getting-started/troubleshooting#downloading-gated-and-private-models).
|
||
|
|
|
||
|
|
**Run:**
|
||
|
|
Start the services with your Hugging Face token using pre-built images:
|
||
|
|
```sh
|
||
|
|
HF_TOKEN=<your_hf_token> docker-compose --profile llamacpp-cpu up
|
||
|
|
```
|
||
|
|
Replace `<your_hf_token>` with your actual Hugging Face token.
|
||
|
|
|
||
|
|
## Building Locally
|
||
|
|
|
||
|
|
If you prefer to build Docker images locally, which is useful when making changes to the codebase or the Dockerfiles, follow these steps:
|
||
|
|
|
||
|
|
### Building Locally
|
||
|
|
To build the Docker images locally, navigate to the cloned repository directory and run:
|
||
|
|
```sh
|
||
|
|
docker-compose build
|
||
|
|
```
|
||
|
|
This command compiles the necessary Docker images based on the current codebase and Dockerfile configurations.
|
||
|
|
|
||
|
|
### Forcing a Rebuild with --build
|
||
|
|
If you have made changes and need to ensure these changes are reflected in the Docker images, you can force a rebuild before starting the services:
|
||
|
|
```sh
|
||
|
|
docker-compose up --build
|
||
|
|
```
|
||
|
|
or with a specific profile:
|
||
|
|
```sh
|
||
|
|
docker-compose --profile <profile_name> up --build
|
||
|
|
```
|
||
|
|
Replace `<profile_name>` with the desired profile.
|