nhost/hasura-backend-plus

Hasura Backend Plus (HBP) 镜像文档

镜像概述和主要用途

Hasura Backend Plus (HBP)是一个为Hasura提供认证和存储功能的后端服务，旨在简化基于Hasura的应用开发流程。它提供完整的用户认证系统和灵活的文件存储解决方案，可与Hasura无缝集成，适用于各类需要用户管理和文件存储的Web及移动应用。

核心功能和特性

• 高度可定制：提供合理默认配置，同时支持完全自定义以满足特定需求
• 易于部署：可在任何环境中快速设置和部署
• 双因素认证：支持双因素认证，增强账户安全性
• 第三方OAuth集成：支持Google、GitHub、、Apple、、Microsoft Live、Linkedin、Spotify等OAuth提供商登录
• 灵活存储规则：支持在任何S3兼容存储实例上配置高度自定义的存储规则
• 邮件验证：可选的电子邮件账户验证功能
• 安全账户管理：支持安全的电子邮件和密码修改流程
• JWKS端点：提供JSON Web Key Set (JWKS)端点，便于JWT验证
• 密码安全检查：可选集成Pwned Passwords检查，防止使用已知泄露密码
• 速率限制：内置速率限制功能，保护API免受滥用
• TypeScript编写：100%使用TypeScript开发，确保代码质量和类型安全

使用场景和适用范围

• 需要快速搭建Hasura后端并集成用户认证的应用开发
• 需支持多种登录方式（***密码、第三方OAuth）的Web应用
• 需要安全文件存储及访问控制的应用（如内容管理系统、用户上传服务）
• 对账户安全性有较高要求（如双因素认证、密码安全检查）的应用
• 希望减少后端开发工作量，专注于前端功能实现的开发团队

使用方法和配置说明

部署方式

HBP可通过多种方式部署，最简便的方式是使用Nhost托管服务，也可通过Docker自行部署。

Docker Run示例

bash
docker run -d \
  --name hbp \
  -p 4000:4000 \
  -e HASURA_GRAPHQL_ENDPOINT=https://your-hasura-instance.hasura.app/v1/graphql \
  -e DATABASE_URL=postgresql://user:password@postgres:5432/hbp \
  -e JWT_SECRET=your-jwt-secret-key \
  -e STORAGE_S3_ENDPOINT=https://s3.your-storage-provider.com \
  -e STORAGE_S3_ACCESS_KEY=your-access-key \
  -e STORAGE_S3_SECRET_KEY=your-secret-key \
  -e STORAGE_S3_BUCKET=your-bucket-name \
  nhost/hasura-backend-plus:latest

Docker Compose示例

yaml
version: '3'
services:
  hbp:
    image: nhost/hasura-backend-plus:latest
    ports:
      - "4000:4000"
    environment:
      - HASURA_GRAPHQL_ENDPOINT=https://your-hasura-instance.hasura.app/v1/graphql
      - DATABASE_URL=postgresql://user:password@postgres:5432/hbp
      - JWT_SECRET=your-jwt-secret-key
      - STORAGE_S3_ENDPOINT=https://s3.your-storage-provider.com
      - STORAGE_S3_ACCESS_KEY=your-access-key
      - STORAGE_S3_SECRET_KEY=your-secret-key
      - STORAGE_S3_BUCKET=your-bucket-name
      - EMAIL_VERIFICATION_ENABLED=true
      - TWO_FACTOR_AUTH_ENABLED=true
    depends_on:
      - postgres

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=hbp
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

主要配置参数

更多信息

完整的使用和安装说明，请参考官方文档：https://nhost.github.io/hasura-backend-plus/