bsord/tiles-api

Tiles API

镜像概述和主要用途

Tiles API是https://github.com/bsord/tiles-client%E5%BA%94%E7%94%A8%E7%9A%84%E5%90%8E%E7%AB%AFAPI%E6%9C%8D%E5%8A%A1%EF%BC%8C%E4%B8%BB%E8%A6%81%E7%94%A8%E4%BA%8E%E6%94%AF%E6%8C%81%E5%89%8D%E7%AB%AF%E5%BA%94%E7%94%A8%E7%9A%84%E6%A0%B8%E5%BF%83%E5%8A%9F%E8%83%BD%EF%BC%8C%E5%8C%85%E6%8B%AC%E5%88%9B%E5%BB%BA%E5%92%8C%E4%BF%9D%E5%AD%98%E7%9C%8B%E6%9D%BF%E3%80%81%E7%94%A8%E6%88%B7%E8%AE%A4%E8%AF%81%E4%BB%A5%E5%8F%8A%E8%81%8A%E5%A4%A9%E5%AE%A4%E7%AE%A1%E7%90%86%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E4%BA%86%E4%BE%BF%E6%8D%B7%E7%9A%84%E9%83%A8%E7%BD%B2%E6%96%B9%E5%BC%8F%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87Docker%E5%BF%AB%E9%80%9F%E5%90%AF%E5%8A%A8%E6%9C%8D%E5%8A%A1%E3%80%82

核心功能和特性

• 看板管理：支持创建、保存和管理看板数据
• 用户认证：处理用户注册、登录等身份验证功能
• 聊天室管理：提供聊天室创建和消息处理功能
• Websocket支持：通过Websocket实现实时通信
• Docker化部署：支持通过Docker容器快速部署

使用场景和适用范围

适用于需要部署Tiles应用后端服务的场景，需配合https://github.com/bsord/tiles-client%E5%89%8D%E7%AB%AF%E5%BA%94%E7%94%A8%E4%BD%BF%E7%94%A8%E3%80%82%E9%80%82%E5%90%88%E4%B8%AA%E4%BA%BA%E6%88%96%E5%9B%A2%E9%98%9F%E6%90%AD%E5%BB%BATiles%E5%8D%8F%E4%BD%9C%E5%B9%B3%E5%8F%B0%EF%BC%8C%E6%BB%A1%E8%B6%B3%E7%9C%8B%E6%9D%BF%E7%AE%A1%E7%90%86%E5%92%8C%E5%AE%9E%E6%97%B6%E8%81%8A%E5%A4%A9%E9%9C%80%E6%B1%82%E3%80%82

使用方法和配置说明

Docker部署

基本运行命令

使用以下命令通过Docker部署Tiles API：

sh
docker run -d --name tiles-api \
  -e MongoURI='mongodb://username:pass@host.io:27017/database' \
  -p 4001:4001 \
  -v "$PWD":/usr/src/app \
  -w /usr/src/app \
  node:8 "npm" "start"

参数说明

• -d：后台运行容器
• --name tiles-api：指定容器名称为tiles-api
• -e MongoURI='mongodb://username:pass@host.io:27017/database'：设置MongoDB连接URI环境变量，需替换为实际的MongoDB连接信息
• -p 4001:4001：端口映射，将容器内4001端口映射到主机4001端口
• -v "$PWD":/usr/src/app：挂载当前目录到容器内/usr/src/app目录
• -w /usr/src/app：设置工作目录为/usr/src/app
• node:8 "npm" "start"：使用node:8镜像，执行npm start命令启动服务

Nginx配置

为同时支持前端和后端服务，可使用以下Nginx配置块：

sh
server {
    listen               443  ssl;
    ssl                  on;
    ssl_certificate fullchain.pem;
    ssl_certificate_key privkey.pem;
    server_name    tiles.mysite.io;
    large_client_header_buffers 4 8k;
    
    # 前端请求代理
    location / {
        proxy_pass      http://127.0.0.1:3000/;
        # WebSocket升级配置
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
    
    # Socket.io请求代理（实时通信）
    location /socket.io/ {
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_http_version 1.1;
        proxy_set_header Host $host;
        proxy_pass http://127.0.0.1:4001/socket.io/;
    }
    
    # Tiles API请求代理
    location /tiles {
        proxy_pass      http://127.0.0.1:4001/tiles;
        # WebSocket升级配置
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

服务访问

服务启动后，Tiles API将在http://localhost:4001接收请求。