bitnami/postgrest

Bitnami PostgREST 镜像文档

1. 镜像概述和主要用途

1.1 PostgREST 简介

PostgREST 是一个 Web 服务器，允许通过 API 端点和操作与 PostgreSQL 数据库进行通信，无需手动编写后端代码即可自动生成 RESTful API。

1.2 Bitnami 镜像概述

Bitnami PostgREST 镜像是基于 PostgREST 官方版本构建的容器化解决方案，旨在简化部署流程，提供安全加固的运行环境，并支持灵活的配置选项，适用于开发、测试及生产环境中快速搭建 PostgreSQL API 服务。

2. 核心功能和特性

2.1 PostgREST 核心功能

• 自动 API 生成：基于 PostgreSQL 数据库结构自动生成 RESTful API 端点
• 权限集成：直接使用 PostgreSQL 的角色和权限系统控制 API 访问
• 数据操作支持：支持 GET、POST、PUT、PATCH、DELETE 等标准 HTTP 方法
• 高级查询能力：支持过滤、排序、分页、连接查询等复杂数据操作

2.2 Bitnami 镜像特性

• 安全加固：基于最小化操作系统（Photon Linux）构建，减少***面
• 供应链安全：提供软件物料清单（SBOM）、漏洞可利用性交换（VEX）报告及 KEV 评分，支持 CVE 风险透明化
• 持续更新：上游补丁发布后数小时内完成镜像更新，确保安全性
• 跨平台一致性：与 Bitnami 虚拟机、云镜像使用相同组件和配置方式，便于格式切换
• 合规性支持：提供签名证明（Notation）、病毒扫描报告等元数据，符合 SLSA-3 软件工厂标准

3. 使用场景和适用范围

• 快速原型开发：无需编写后端代码，直接为 PostgreSQL 数据库提供 API 服务
• 小型应用后端：适用于轻量级应用的 REST API 层构建
• 开发/测试环境：简化本地开发和 CI/CD 流程中的 API 服务部署
• 安全合规场景：需要最小***面和供应链安全保障的企业级应用

4. 重要通知：Bitnami 目录即将变更

自 2025 年 8 月 28 日起，Bitnami 将调整其公共目录，推出新的 Bitnami Secure Images 计划，主要变更包括：

• 安全镜像开放：首次向社区用户提供安全优化版容器镜像访问权限
• 非加固镜像 deprecation：逐步停止对非加固 Debian 基础镜像的免费支持，公共目录将仅保留少量加固镜像的 "latest" 标签（用于开发目的）
• 旧标签迁移：所有现有容器镜像（包括版本化标签，如 2.50.0、10.6）将在两周内从公共目录（docker.io/bitnami）迁移至 "Bitnami Legacy" 仓库（docker.io/bitnamilegacy），且不再接收更新
• 生产环境建议：生产工作负载建议采用 Bitnami Secure Images，包含加固容器、CVE 透明度、企业支持等特性

更多详情请参见 https://github.com/bitnami/containers/issues/83267%E3%80%82

5. 使用方法

5.1 获取镜像

推荐从 Docker Hub 拉取预构建镜像：

console
# 拉取最新版
docker pull bitnami/postgrest:latest

# 拉取特定版本（需注意：2025年8月28日后版本化标签将迁移至 bitnamilegacy 仓库）
docker pull bitnami/postgrest:[TAG]

如需手动构建，可克隆 Bitnami 容器仓库并执行构建命令：

console
git clone https://github.com/bitnami/containers.git
cd bitnami/postgrest/[VERSION]/[OPERATING-SYSTEM]
docker build -t bitnami/postgrest:latest .

5.2 基本运行

快速启动 PostgREST 容器（需提前部署 PostgreSQL 并配置连接信息）：

console
docker run -it --name postgrest bitnami/postgrest

5.3 Docker Compose 配置

以下是包含 PostgREST 和 PostgreSQL 的 docker-compose 示例配置：

yaml
version: '3.8'

services:
  postgres:
    image: bitnami/postgresql:latest
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=postgres
    volumes:
      - postgres_data:/bitnami/postgresql

  postgrest:
    image: bitnami/postgrest:latest
    depends_on:
      - postgres
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_USER=postgres
      - DB_PASSWORD=postgres
      - DB_NAME=postgres
      - PGRST_JWT_SECRET=your_jwt_secret
      - PGRST_DB_ANON_ROLE=anon
    ports:
      - "3000:3000"

volumes:
  postgres_data:

5.4 升级维护

步骤 1：拉取更新镜像

console
docker pull bitnami/postgrest:latest

步骤 2：停止并删除当前容器

console
docker stop postgrest && docker rm -v postgrest

步骤 3：使用新镜像启动容器

console
docker run --name postgrest bitnami/postgrest:latest

6. 配置说明

6.1 环境变量

6.1.1 可定制环境变量

6.1.2 只读环境变量

6.2 运行命令

在容器内执行 PostgREST 命令（如查看帮助）：

console
docker run --rm --name postgrest bitnami/postgrest:latest --help

更多命令参数可参考 PostgREST 官方文档。

6.3 FIPS 配置

Bitnami 安全镜像支持 FIPS（联邦信息处理标准）模式，可通过以下环境变量配置：

• OPENSSL_FIPS：是否启用 OpenSSL FIPS 模式，可选值 yes（默认）或 no

7. 显著变更

• 2024 年 1 月 16 日起：移除 docker-compose.yaml 文件，该文件仅用于内部测试目的。

8. 贡献与反馈

• 贡献代码：通过 https://github.com/bitnami/containers 提交 issue 或 pull request。
• 问题反馈：如在使用中遇到问题，可在 https://github.com/bitnami/containers/issues/new/choose 提交详细报告（建议填写 issue 模板以获得更好支持）。

9. 许可证

本软件包由 Bitnami 打包，相关商标归各自公司所有，使用不意味着任何关联或背书。
版权所有 © 2025 Broadcom。"Broadcom" 指 Broadcom Inc. 及其子公司。
根据 Apache 许可证 2.0 版授权（详见 [***] "原样" 分发，不提供任何明示或暗示的担保。