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
18 changes: 9 additions & 9 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

**MAX API 2.0: entering the intelligent operations era · evolving from a unified model gateway to AGI-native governance and operations**

[View the MAX API 2.0 Preview release notes](https://github.com/MAX-API-Next/MAX-API/releases/tag/v2.0.0-smartops.pre1)
[View the latest stable release notes](https://github.com/MAX-API-Next/MAX-API/releases/latest)

<p align="center">
<a href="./README.zh_CN.md">简体中文</a> |
Expand All @@ -23,7 +23,7 @@
<img src="https://img.shields.io/github/license/MAX-API-Next/MAX-API?color=brightgreen" alt="license">
</a><!--
--><a href="https://github.com/MAX-API-Next/MAX-API/releases/latest">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen&include_prereleases" alt="release">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen" alt="release">
</a><!--
--><a href="https://hub.docker.com/r/cscitechtop/max-api">
<img src="https://img.shields.io/badge/docker-dockerHub-blue" alt="docker">
Expand All @@ -47,7 +47,7 @@
<a href="#-technical-direction-for-agi">AGI direction</a> •
<a href="#-current-capabilities">Capabilities</a> •
<a href="#-intelligent-operations-center">SmartOps</a> •
<a href="#-preview-deployment">Preview deployment</a>
<a href="#-deployment-guide">Deployment guide</a>
</p>

</div>
Expand All @@ -73,7 +73,7 @@ MAX API is more than a code repository. It is a long-term open collaboration aro
|---|---|
| [MAX-API-Next on GitHub](https://github.com/MAX-API-Next) | Follow community projects, technical direction, and open collaboration |
| [MAX API Issues](https://github.com/MAX-API-Next/MAX-API/issues) | Report reproducible problems, propose improvements, and share compatibility changes |
| [MAX API Releases](https://github.com/MAX-API-Next/MAX-API/releases) | Follow stable and Preview releases |
| [MAX API Releases](https://github.com/MAX-API-Next/MAX-API/releases) | Follow stable release updates |
| [Ask DeepWiki](https://deepwiki.com/MAX-API-Next/MAX-API) | Search and understand the codebase quickly |
| Technical and ecosystem cooperation | Contact `maxapi@max-api.ai` |

Expand Down Expand Up @@ -179,7 +179,7 @@ Open <http://localhost:3000>, then:
3. Create an access token and point your application's Base URL to MAX API.

> [!TIP]
> Use stable releases in production. Preview releases are intended for testing and staged validation. Back up the database and prepare a rollback plan before upgrading.
> Use a confirmed stable release tag in production. Back up the database and prepare a rollback plan before upgrading.
>
> [!WARNING]
> SQLite is suitable for local evaluation, development, and small-scale tests. For production, use MySQL or PostgreSQL versions that remain within the vendor's security-support lifecycle (MySQL 8.4 LTS and PostgreSQL 14+ are recommended), together with Redis, HTTPS, backups, and recovery procedures. Compatibility minimums remain MySQL ≥ 5.7.8 and PostgreSQL ≥ 9.6, but those versions are not recommended for production.
Expand Down Expand Up @@ -289,15 +289,15 @@ MAX API will continue to make **AI Models and Agents governance** its core. Star

MAX API is not a foundation model and does not claim to have already achieved AGI or autonomous operations. Long-term capabilities will be validated gradually only after Evidence, permission, budget, approval, and rollback boundaries are in place.

## 🚢 Preview deployment
## 🚢 Deployment guide

The following steps are for Preview testing and staged validation. For production, use a stable release and keep the same verification and rollback process.
The following steps use a stable release as an example. Pin the version tag and commit, and complete backup, verification, and rollback preparation before upgrading.

Docker Compose is recommended:

```bash
MAX_API_VERSION=v2.0.0-smartops.pre1
MAX_API_COMMIT=b7096156549edc930ca244891afb1ba5632dbe8f
MAX_API_VERSION=v1.0.5
MAX_API_COMMIT=74a7ed3e4e2989c7e6f32b88a6b55e8446d2534e
git clone --branch "$MAX_API_VERSION" --depth 1 https://github.com/MAX-API-Next/MAX-API.git
cd MAX-API

Expand Down
18 changes: 9 additions & 9 deletions README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

**MAX API 2.0 : entrer dans l'ère de l'exploitation intelligente · évoluer d'une passerelle de modèles unifiée vers une infrastructure native de gouvernance et d'exploitation AGI**

[Consulter les notes de version MAX API 2.0 Preview](https://github.com/MAX-API-Next/MAX-API/releases/tag/v2.0.0-smartops.pre1)
[Consulter les notes de la dernière version stable](https://github.com/MAX-API-Next/MAX-API/releases/latest)

<p align="center">
<a href="./README.zh_CN.md">简体中文</a> |
Expand All @@ -23,7 +23,7 @@
<img src="https://img.shields.io/github/license/MAX-API-Next/MAX-API?color=brightgreen" alt="licence">
</a><!--
--><a href="https://github.com/MAX-API-Next/MAX-API/releases/latest">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen&include_prereleases" alt="version">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen" alt="version">
</a><!--
--><a href="https://hub.docker.com/r/cscitechtop/max-api">
<img src="https://img.shields.io/badge/docker-dockerHub-blue" alt="docker">
Expand All @@ -47,7 +47,7 @@
<a href="#-orientation-technique-pour-lagi">Orientation AGI</a> •
<a href="#-capacités-actuelles">Capacités</a> •
<a href="#-centre-dexploitation-intelligente">SmartOps</a> •
<a href="#-déploiement-preview">Déploiement Preview</a>
<a href="#-guide-de-déploiement">Guide de déploiement</a>
</p>

</div>
Expand All @@ -73,7 +73,7 @@ MAX API est plus qu'un dépôt de code. C'est une collaboration ouverte de long
|---|---|
| [MAX-API-Next sur GitHub](https://github.com/MAX-API-Next) | Suivre les projets communautaires, les orientations techniques et la collaboration ouverte |
| [Issues MAX API](https://github.com/MAX-API-Next/MAX-API/issues) | Signaler un problème reproductible, proposer une amélioration ou partager un changement de compatibilité |
| [Versions MAX API](https://github.com/MAX-API-Next/MAX-API/releases) | Suivre les versions stables et Preview |
| [Versions MAX API](https://github.com/MAX-API-Next/MAX-API/releases) | Suivre les mises à jour des versions stables |
| [Ask DeepWiki](https://deepwiki.com/MAX-API-Next/MAX-API) | Rechercher et comprendre rapidement le code |
| Coopération technique et écosystème | Contacter `maxapi@max-api.ai` |

Expand Down Expand Up @@ -179,7 +179,7 @@ Ouvrez ensuite <http://localhost:3000>, puis :
3. Créez un jeton d'accès et pointez la Base URL de votre application vers MAX API.

> [!TIP]
> Utilisez les versions stables en production. Les versions Preview sont destinées aux tests et à la validation progressive. Sauvegardez la base et préparez un rollback avant toute mise à niveau.
> Utilisez une version stable confirmée en production. Sauvegardez la base et préparez un rollback avant toute mise à niveau.
>
> [!WARNING]
> SQLite convient à l'évaluation locale, au développement et aux tests de petite taille. En production, utilisez des versions de MySQL ou PostgreSQL toujours couvertes par le support de sécurité du fournisseur (MySQL 8.4 LTS et PostgreSQL 14+ recommandés), avec Redis, HTTPS, sauvegardes et procédures de reprise. Les minimums de compatibilité restent MySQL ≥ 5.7.8 et PostgreSQL ≥ 9.6, mais ces versions ne sont pas recommandées en production.
Expand Down Expand Up @@ -289,15 +289,15 @@ MAX API continuera de placer **AI Models and Agents governance** au cœur du pro

MAX API n'est pas un modèle de fondation et ne prétend pas avoir déjà atteint l'AGI ni l'exploitation autonome. Les capacités de long terme ne seront validées progressivement qu'après mise en place des frontières d'Evidence, de permissions, de budget, d'approbation et de rollback.

## 🚢 Déploiement Preview
## 🚢 Guide de déploiement

Les étapes suivantes servent aux tests et à la validation progressive de la version Preview. Pour la production, utilisez une version stable et conservez la même procédure de vérification et de retour arrière.
Les étapes suivantes prennent une version stable comme exemple. Figez le tag et le commit utilisés, puis préparez la sauvegarde, la vérification et le retour arrière avant toute mise à niveau.

Docker Compose est recommandé :

```bash
MAX_API_VERSION=v2.0.0-smartops.pre1
MAX_API_COMMIT=b7096156549edc930ca244891afb1ba5632dbe8f
MAX_API_VERSION=v1.0.5
MAX_API_COMMIT=74a7ed3e4e2989c7e6f32b88a6b55e8446d2534e
git clone --branch "$MAX_API_VERSION" --depth 1 https://github.com/MAX-API-Next/MAX-API.git
cd MAX-API

Expand Down
18 changes: 9 additions & 9 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

**MAX API 2.0:インテリジェント運用の時代へ · 統一モデルゲートウェイから AGI ネイティブなガバナンス/運用基盤へ**

[MAX API 2.0 Preview リリースノートを見る](https://github.com/MAX-API-Next/MAX-API/releases/tag/v2.0.0-smartops.pre1)
[最新の正式版リリースノートを見る](https://github.com/MAX-API-Next/MAX-API/releases/latest)

<p align="center">
<a href="./README.zh_CN.md">简体中文</a> |
Expand All @@ -23,7 +23,7 @@
<img src="https://img.shields.io/github/license/MAX-API-Next/MAX-API?color=brightgreen" alt="license">
</a><!--
--><a href="https://github.com/MAX-API-Next/MAX-API/releases/latest">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen&include_prereleases" alt="release">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen" alt="release">
</a><!--
--><a href="https://hub.docker.com/r/cscitechtop/max-api">
<img src="https://img.shields.io/badge/docker-dockerHub-blue" alt="docker">
Expand All @@ -47,7 +47,7 @@
<a href="#-agi-に向けた技術方針">AGI 技術方針</a> •
<a href="#-現在の機能">現在の機能</a> •
<a href="#-インテリジェント運用センター">SmartOps</a> •
<a href="#-preview-デプロイ">Preview デプロイ</a>
<a href="#-デプロイガイド">デプロイガイド</a>
</p>

</div>
Expand All @@ -73,7 +73,7 @@ MAX API は単なるコードリポジトリではありません。AI Models、
|---|---|
| [MAX-API-Next GitHub](https://github.com/MAX-API-Next) | コミュニティプロジェクト、技術方針、オープンコラボレーションをフォロー |
| [MAX API Issues](https://github.com/MAX-API-Next/MAX-API/issues) | 再現可能な問題、改善提案、互換性の変化を共有 |
| [MAX API Releases](https://github.com/MAX-API-Next/MAX-API/releases) | 正式版と Preview 版の更新を確認 |
| [MAX API Releases](https://github.com/MAX-API-Next/MAX-API/releases) | 正式版の更新を確認 |
| [Ask DeepWiki](https://deepwiki.com/MAX-API-Next/MAX-API) | コードベースをすばやく検索・理解 |
| 技術・エコシステム連携 | `maxapi@max-api.ai` まで連絡 |

Expand Down Expand Up @@ -179,7 +179,7 @@ docker run --name max-api -d --restart always -p 127.0.0.1:3000:3000 -e TZ=Asia/
3. アクセストークンを作成し、アプリケーションの Base URL を MAX API に向ける。

> [!TIP]
> 本番環境では正式版を使用してください。Preview 版はテストと段階的検証向けです。アップグレード前にデータベースをバックアップし、ロールバック手順を準備してください。
> 本番環境では確認済みの正式版タグを固定して使用してください。アップグレード前にデータベースをバックアップし、ロールバック手順を準備してください。
>
> [!WARNING]
> SQLite はローカル評価、開発、小規模テスト向けです。本番環境では、ベンダーのセキュリティサポート期間内にある MySQL(8.4 LTS 推奨)または PostgreSQL(14+ 推奨)を使用し、Redis、HTTPS、バックアップ、復旧手順を構成してください。互換性の下限は MySQL ≥ 5.7.8、PostgreSQL ≥ 9.6 ですが、これらのバージョンを本番で使用することは推奨しません。
Expand Down Expand Up @@ -289,15 +289,15 @@ MAX API は今後も **AI Models and Agents governance** を中核とします

MAX API は基盤モデルではなく、現時点で AGI や自律運用を実現済みと主張しません。長期機能は Evidence、権限、予算、承認、ロールバックの境界が整った後にのみ段階的に検証します。

## 🚢 Preview デプロイ
## 🚢 デプロイガイド

以下の手順は Preview 版のテストと段階的検証向けです。本番環境では正式版を使用し、同じ検証とロールバック手順を維持してください。
以下の手順は正式版を例にしています。使用するバージョンタグとコミットを固定し、アップグレード前にバックアップ、検証、ロールバックの準備を完了してください。

Docker Compose を推奨します:

```bash
MAX_API_VERSION=v2.0.0-smartops.pre1
MAX_API_COMMIT=b7096156549edc930ca244891afb1ba5632dbe8f
MAX_API_VERSION=v1.0.5
MAX_API_COMMIT=74a7ed3e4e2989c7e6f32b88a6b55e8446d2534e
git clone --branch "$MAX_API_VERSION" --depth 1 https://github.com/MAX-API-Next/MAX-API.git
cd MAX-API

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

**MAX API 2.0:开启智能运维时代 · 从统一模型网关走向 AGI 原生治理与运营**

[查看 MAX API 2.0 Preview 发布说明](https://github.com/MAX-API-Next/MAX-API/releases/tag/v2.0.0-smartops.pre1)
[查看最新正式版发布说明](https://github.com/MAX-API-Next/MAX-API/releases/latest)

<p align="center">
<strong>简体中文</strong> |
Expand All @@ -23,7 +23,7 @@
<img src="https://img.shields.io/github/license/MAX-API-Next/MAX-API?color=brightgreen" alt="license">
</a><!--
--><a href="https://github.com/MAX-API-Next/MAX-API/releases/latest">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen&include_prereleases" alt="release">
<img src="https://img.shields.io/github/v/release/MAX-API-Next/MAX-API?color=brightgreen" alt="release">
</a><!--
--><a href="https://hub.docker.com/r/cscitechtop/max-api">
<img src="https://img.shields.io/badge/docker-dockerHub-blue" alt="docker">
Expand All @@ -47,7 +47,7 @@
<a href="#-面向-agi-的技术方向">AGI 技术方向</a> •
<a href="#-当前能力">当前能力</a> •
<a href="#-智能运维中心">智能运维</a> •
<a href="#-preview-部署">Preview 部署</a>
<a href="#-部署指南">部署指南</a>
</p>

</div>
Expand All @@ -73,7 +73,7 @@ MAX API 不只是一个代码仓库,也是一项面向 AI Models、Agents、Ag
|---|---|
| [MAX-API-Next GitHub](https://github.com/MAX-API-Next) | 关注社区项目、技术方向与开放协作 |
| [MAX API Issues](https://github.com/MAX-API-Next/MAX-API/issues) | 提交可复现问题、需求建议和兼容性变化 |
| [MAX API Releases](https://github.com/MAX-API-Next/MAX-API/releases) | 获取正式版与 Preview 版本动态 |
| [MAX API Releases](https://github.com/MAX-API-Next/MAX-API/releases) | 获取正式版本发布动态 |
| [Ask DeepWiki](https://deepwiki.com/MAX-API-Next/MAX-API) | 快速检索和理解项目代码 |
| 技术与生态合作 | 联系 `maxapi@max-api.ai` |

Expand Down Expand Up @@ -181,7 +181,7 @@ docker run --name max-api -d --restart always -p 127.0.0.1:3000:3000 -e TZ=Asia/
3. 创建访问令牌,把应用中的 Base URL 指向 MAX API。

> [!TIP]
> 生产环境建议使用正式版。Preview 版本用于测试和灰度验证,升级前请备份数据库并准备回滚方案。
> 生产环境请固定使用已确认的正式版标签,升级前请备份数据库并准备回滚方案。
>
> [!WARNING]
> SQLite 适合本地体验、开发和小规模测试。正式环境建议使用仍在供应商安全支持周期内的 MySQL(建议 8.4 LTS)或 PostgreSQL(建议 14+),并配置 Redis、HTTPS、备份和恢复方案。项目兼容性下限仍为 MySQL ≥ 5.7.8、PostgreSQL ≥ 9.6,但不建议将其用于生产。
Expand Down Expand Up @@ -291,15 +291,15 @@ MAX API 将继续以 **AI Models and Agents governance** 为核心,从统一

MAX API 不是基础模型,也不宣称当前已经实现 AGI 或自治运维。路线图中的长期能力只有在证据、权限、预算、审批和回滚边界完善后才会逐步验证。

## 🚢 Preview 部署
## 🚢 部署指南

以下步骤用于 Preview 版本的测试和灰度验证。生产环境请改用正式版,并沿用相同的校验和回滚流程。
以下步骤以正式版为例。请固定版本标签和对应提交,并在升级前完成备份、校验和回滚准备。

推荐使用 Docker Compose:

```bash
MAX_API_VERSION=v2.0.0-smartops.pre1
MAX_API_COMMIT=b7096156549edc930ca244891afb1ba5632dbe8f
MAX_API_VERSION=v1.0.5
MAX_API_COMMIT=74a7ed3e4e2989c7e6f32b88a6b55e8446d2534e
git clone --branch "$MAX_API_VERSION" --depth 1 https://github.com/MAX-API-Next/MAX-API.git
cd MAX-API

Expand Down
Loading
Loading