Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 0 additions & 83 deletions .github/workflows/build_and_deploy_docusaurus.yml

This file was deleted.

38 changes: 38 additions & 0 deletions .github/workflows/deploy_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Deploy Docusaurus to GitHub Pages

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_call: # Add this to make the workflow reusable
workflow_dispatch: # Add this to allow manual triggering

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache-dependency-path: ./docs/package-lock.json
- name: Install dependencies
working-directory: ./docs
run: npm ci
- name: Build Docusaurus site
working-directory: ./docs
run: npm run build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build
publish_branch: gh-pages
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<img src="./docs/static/img/ogl_logo.svg" alt="Logo" width="128" height="128">

# OpenGateLLM
[**API Reference**](https://albert.api.etalab.gouv.fr/documentation)
[Documentation](https://docs.opengatellm.etalab.gouv.fr) | [API Reference](https://albert.api.etalab.gouv.fr/documentation)

> [!WARNING]
> **The API is still under beta version, major breaking changes may occur.**

Production-ready API gateway for self-hosted LLMs developed by the French Government, fully open-source forever.

| Feature | Description |
|---------|-------------|
|---|---|
| Gateway | • OpenAI compatible API<br>• Self-hosted models backend support: vLLM, HuggingFace TEI, Ollama <br>• Commercial backend support: OpenAI<br>• Full stack genAI API: chat, embeddings, transcription, RAG and OCR |
| Account services | • SSO support<br>• Organization, project, key management<br>• Budget, usage and carbon footprint monitoring |
| Monitoring | • Usage and carbon footprint monitoring |
Expand All @@ -24,7 +24,7 @@ Production-ready API gateway for self-hosted LLMs developed by the French Govern
***

| Feature | OpenGateLLM | LiteLLM | OpenRouter |
| -------------------- | ------------ | --------- | ---------- |
| ---| ---| --- | --- |
| OpenAI Compatibility | ✅ | ✅ | ✅ |
| Open Source | ✅ | ✅ | ❌ |
| Free (all features) | ✅ | ❌ | ❌ |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ It is recommended to use a Python [virtualenv](https://docs.python.org/3/library
# POSTGRES_HOST=postgres
```

4. Check the [configuration documentation](./docs/configuration.md) to configure your configuration file.
4. Check the [configuration documentation](../getting-started/configuration.md) to configure your configuration file.

## Launch services

Expand Down
4 changes: 1 addition & 3 deletions docs/docs/functionalities/rag.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,4 @@ settings:
vector_store_model: embeddings-small
```

6. Run OpenGateLLM as described in:
- [running OpenGateLLM inside docker](contributing/inside-docker.mdx)
- [running OpenGateLLM outside docker](contributing/outside-docker.mdx)
6. Run OpenGateLLM as described in [quickstart](../getting-started/quickstart.md
4 changes: 2 additions & 2 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ const config: Config = {
},

// Set the production url of your site here
url: albert_api_url,
url: 'https://docs.opengatellm.etalab.gouv.fr',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: baseUrl,
baseUrl: '/',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ const sidebars: SidebarsConfig = {
label: 'Getting Started',
items: [
'getting-started/quickstart',
'getting-started/environment_variables',
'getting-started/configuration',
'getting-started/environment_variables',
],
},
{
Expand Down
Loading