elementh/taas

TaaS — 感谢即服务（Thanks as a Service）

镜像概述和主要用途

TaaS是一个公共API，旨在简化表达感谢的过程。用户可部署私有实例，利用PostgreSQL数据库存储数据，并支持自定义数据源和数据库更新间隔，适用于需要便捷表达感谢的个人或组织场景。

核心功能和特性

• 公共API服务：提供便捷的感谢表达接口
• 社区驱动数据集：使用社区维护的数据集填充数据库，数据可在https://github.com/elementh/taas.data%E8%8E%B7%E5%8F%96
• 可自定义配置：支持自定义数据源URL和数据库更新间隔（Cron格式）
• 私有部署支持：可通过Docker或源码方式部署私有实例

使用场景和适用范围

• 个人用户：需要简单方式表达感谢的场景
• 组织或团队：希望集成感谢表达功能到自有系统中
• 开发者：需要可定制的感谢API服务，用于应用开发

使用方法和配置说明

运行实例的两种方式

1. 下载源码并使用dotnet启动服务器
2. 通过Docker部署（推荐）

系统要求

两种方式均需满足以下基本要求：

• 必需：PostgreSQL数据库
• 必需环境变量：
  • DB_CONNECTION_STRING：PostgreSQL数据库连接字符串
• 可选环境变量：
  • IMPORTER_SOURCE_URL：自定义数据源URL，默认值为https://raw.githubusercontent.com/elementh/taas.data/master/src
  • IMPORTER_CRON_CONFIGURATION：数据库更新间隔的Cron配置，默认值为0 0 1 * *（每月1日午夜检查更新），Cron格式说明参见https://github.com/HangfireIO/Cronos#cron-format

Docker部署示例

官方Docker镜像https://hub.docker.com/r/elementh/taas%E6%9A%B4%E9%9C%B2%E7%AB%AF%E5%8F%A35100%E3%80%82

以下是一个简单可用的docker-compose配置示例：

yaml
taas:
    image: elementh/taas:0.1.1
    restart: unless-stopped
    container_name: taas
    environment:
        DB_CONNECTION_STRING: "Server=taas_database;Port=5432;Database=taas;User Id=taas;Password=taas;"
    ports:
        - 5100:5100 # 仅在不使用traefik等反向代理时需要

taas_database:
    image: postgres:12.1-alpine   
    restart: unless-stopped
    container_name: taas_database
    environment:
        POSTGRES_USER: "taas"
        POSTGRES_PASSWORD: "taas"
    volumes:
        - ./db-taas:/var/lib/postgresql/data

许可证

TaaS — 感谢即服务（Thanks as a Service）

版权所有 (C) 2020 Lucas Maximiliano Marino <[***]>

本程序是自由软件：您可以根据自由软件基金会发布的GNU通用公共许可证（第三版或更高版本）重新分发和/或修改它。

本程序的分发旨在希望它有用，但不提供任何担保，包括但不限于适销性或特定用途的适用性。详见GNU通用公共许可证。

您应已收到GNU通用公共许可证的副本，如未收到，请参见<[***]>。