Onyxia API 镜像文档

1. 镜像概述和主要用途

Onyxia API 是一款由法国国家统计与经济研究所（Insee，[***]

2. 核心功能与特性

当前开源初期，详细功能特性文档仍在完善中，敬请期待后续更新。

3. 使用场景与适用范围

主要用于 Insee 内部业务系统，具体适用场景将随开源文档完善进一步明确。

4. 使用方法

4.1 前提条件

• 若通过 Docker 使用：需已安装 Docker 环境。
• 若通过 Java 源码编译：需已安装 Java 环境及 Maven 构建工具。

4.2 Docker 快速启动

通过 Docker 镜像直接启动服务：

docker run -p 8080:8080 inseefrlab/onyxia-api

说明：

• -p 8080:8080：将容器内 8080 端口映射到主机 8080 端口，可根据需求调整主机端口（如 -p 9090:8080 映射到主机 9090 端口）。

4.3 Java (Maven) 源码启动

若需从源码编译运行，执行以下命令：

mvn spring-boot:run

4.4 Docker Compose 部署示例

创建 docker-compose.yml 文件，内容如下：

version: '3'
services:
  onyxia-api:
    image: inseefrlab/onyxia-api
    ports:
      - "8080:8080"
    # 如需自定义环境变量，可添加 environment 配置
    # environment:
    #   - VAR_NAME=value

启动服务：

docker-compose up -d

5. 配置说明

5.1 配置文件路径

应用核心配置文件路径为：

onyxia-api/src/main/resources/application.properties

5.2 环境变量覆盖

配置文件中的所有变量均可通过环境变量覆盖。例如，若配置文件中存在 server.port=8080，可通过环境变量 server.port=9090 覆盖端口配置。

使用示例（Docker 启动时覆盖环境变量）：

docker run -p 9090:9090 -e server.port=9090 inseefrlab/onyxia-api

6. 注意事项

• 该项目处于开源初期，文档和功能仍在持续迭代中，使用前建议关注官方更新。
• 生产环境部署时，建议根据实际需求调整端口、环境变量等配置，并做好容器资源限制和持久化方案。