jonfairbanks/yo-api

Yo - URL缩短器

镜像概述和主要用途

Yo是一个轻量级URL缩短器，旨在将冗长、难以记忆的URL转换为简洁、易于分享的短链接，提升链接的可用性和传播效率。支持自定义链接名称、访问统计，并可通过Auth0实现用户认证，确保链接管理的安全性。

核心功能和特性

• URL缩短：将长URL转换为简短链接，支持自定义链接名称
• 链接管理：提供编辑、删除链接的功能，支持访问统计
• 用户认证：通过Auth0实现用户登录，防止未授权访问和操作
• 前后端分离：基于React前端和Node.js后端的架构，支持WebSocket实时更新
• 灵活配置：通过环境变量自定义部署参数，如API地址、数据库连接等
• 容器化部署：提供Dockerfile和docker-compose配置，支持快速部署
• 数据持久化：使用MongoDB存储链接数据，确保数据可靠性

使用场景和适用范围

• 个人用户：简化社交媒体、邮件中的长URL，方便分享和记忆
• 企业/团队：统一管理内部系统链接，提升工作效率
• 内容创作者：缩短推广链接，便于跟踪点击量和传播效果
• 开发者：集成到应用中，提供URL缩短功能

详细使用方法和配置说明

前提条件

• Docker及Docker Compose（推荐）
• 或Node.js v8+、MongoDB、Nginx（手动部署）

Docker部署示例

使用docker-compose部署

1. 克隆项目：

sh
git clone https://github.com/jonfairbanks/yo.git
cd yo

2. 创建.env文件配置环境变量（参考下方环境变量说明）

3. 启动服务：

sh
docker-compose up -d

手动运行Docker容器（前端）

sh
docker run -d \
  --name yo-client \
  -p 3000:3000 \
  -e REACT_APP_API_URL=https://yo-api.mysite.io/api/ \
  -e REACT_APP_SOCKET_URL=https://yo-api.mysite.io \
  -e REACT_APP_BASE_URL=https://yo.mysite.io \
  docker.xuanyuan.run/jonfairbanks/yo-client

手动运行Docker容器（后端）

sh
docker run -d \
  --name yo-server \
  -p 7000:7000 \
  -e ERROR_URL=https://mysite.io/error \
  -e BASE_URL=https://yo.mysite.io \
  -e API_URL=https://yo-api.mysite.io/api/ \
  -e MONGO_URI=mongodb://mongo:27017/yo \
  --link mongo:mongo \
  docker.xuanyuan.run/jonfairbanks/yo-server

环境变量配置

客户端环境变量

服务器环境变量

Nginx配置示例

前端Nginx配置

nginx
server {
    location /manifest.json {
        proxy_pass http://127.0.0.1:3000/manifest.json;
    }
    location / {
        proxy_pass http://127.0.0.1:3000/;
        proxy_set_header X-Real-IP $remote_addr;
        # 支持WebSocket
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

后端Nginx配置

nginx
server {
    location ~* "^/[0-9a-z!?@_-]{1,99}$"  {
        proxy_set_header X-Real-IP $remote_addr;
        rewrite ^/(.*)$ https://my-api-url.com/api/link/$1 redirect;
    }
    location /socket.io {
        proxy_pass http://127.0.0.1:7000;
        proxy_set_header x-real-ip $remote_addr;
        # 支持WebSocket
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
    location / {
        proxy_pass http://127.0.0.1:7000;
        proxy_set_header X-Real-IP $remote_addr;
        # 支持WebSocket
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

启用API认证

默认情况下，Yo后端API是开放的，可能导致未授权访问。通过Auth0启用认证可提升安全性：

1. 在Auth0注册账号并创建“常规Web应用”
2. 配置应用并记录客户端ID和域名
3. 在客户端环境变量中设置REACT_APP_AUTH=true、REACT_APP_AUTH0_CLIENT和REACT_APP_AUTH0_DOMAIN
4. 在服务器环境变量中设置AUTH=true和AUTH0_DOMAIN（需与客户端一致）
5. 在Auth0的“用户与角色”中创建应用用户
6. 启动应用后，使用创建的用户登录即可访问受保护功能

注：默认禁用用户注册，若需开启可设置客户端环境变量REACT_APP_SIGNUPS=true

架构

!https://raw.githubusercontent.com/jonfairbanks/yo/master/images/architecture.png

额外说明

• 使用PM2管理Node进程时，可通过项目中的yo-pm2.yaml配置启动和部署
• 项目提供完整的Docker化部署支持，通过docker-compose.yaml可一键部署前端、后端和数据库