Quickstart

Clone the repository

git clone https://github.com/etalab-ia/OpenGateLLM.git
cd OpenGateLLM

Install Python dependencies

make quickstart invokes cli.py, which needs a few Python packages. Install them with:
Terminal window
```
pip install ".[dev]"
```
A virtual environment is recommended.
Make quickstart

Run OpenGateLLM quickstart with the following command:
Terminal window
```
make quickstart
```
The services are running and available at the following URLs:
- API – http://localhost:8000/docs
- Playground – http://localhost:8501
Quickstart command
This command will launch the OpenGateLLM API and Playground, and their required dependencies, Postgres and Redis, in Docker containers. Moreover, it will copy these three files if they don’t already exist:
- config.example.yml → config.yml
- env.example → .env
- compose.example.yml → compose.yml
ARM64 hosts (Apple Silicon)
Official OpenGateLLM images are published for linux/amd64 only. On ARM64, run:
Terminal window
```
DOCKER_DEFAULT_PLATFORM=linux/amd64 make quickstart
```
For a persistent setup, add platform: linux/amd64 to the api and playground services in your local compose.yml (the copy created by the quickstart command — do not edit compose.example.yml):
```
api:
  platform: linux/amd64
  image: ghcr.io/etalab-ia/opengatellm/api:latest
playground:
  platform: linux/amd64
  image: ghcr.io/etalab-ia/opengatellm/playground:latest
```
On Docker Desktop for Mac, also enable use Rosetta for x86/amd64 emulation on Apple Silicon.
The bootstrap admin user is created and you can connect to the Playground with the following credentials:
- email: admin
- password: changeme
This user is created at the first startup into a new role called bootstrap_admin with the permission ADMIN. We recommend deleting it after you have created your own admin account. See configuration file documentation for more information about the bootstrap admin user.
Setup models

Now, you can setup your models to expose them to your users.
Setup your models