Screensy 技术文档

Screensy 技术文档

screensy Simple peer-to-peer screen sharing 项目地址: https://gitcode.com/gh_mirrors/sc/screensy

---

安装指南

使用Docker部署

1. 安装Docker: 参考Docker官方安装指南进行安装。
2. 安装Docker Compose: 按照Docker Compose官方安装步骤操作。
3. 克隆项目:

   git clone https://github.com/screensy/screensy.git
   cd screensy
   

4. 配置Caddyfile: 将第一行的域名改为你的实际域名。
5. 可选：设置密码保护。
6. 修改turnserver.conf: 更新外部IP地址为你的域名。
7. 确保端口可达。
8. 启动服务:

   docker-compose up -d
   

非Docker部署

1. 必备软件:
   • NodeJS
   • TypeScript编译器
   • Go编译器
   • 支持WebSocket的反向代理（推荐Caddy）
   • STUN服务器（推荐Coturn）
   • TURN服务器（推荐Coturn）
2. 项目克隆与导航:

   git clone https://github.com/screensy/screensy.git
   cd screensy
   

3. 安装与编译:
   • 完成各自目录下的依赖安装和TypeScript文件编译。
4. Web服务器启动:

   cd screensy-website && go run main.go
   

5. STUN与TURN服务器配置与启动。
6. Caddyfile配置以进行反向代理。

项目的使用说明

Screensy分为两部分：服务器端和客户端（浏览器）。广播者通过浏览器分享屏幕，观众同样在浏览器中观看。协议谈判和发现观众由rendezvous服务器处理，视频流直接从广播者的浏览器传给每个观众，所有通信加密。

• 使用流程:
  1. 广播者访问项目运行的域名，启动屏幕共享。
  2. 分享生成的链接给观众。
  3. 观众点击链接，直接在浏览器内观看屏幕共享。

项目API使用文档

Screensy主要依赖于WebSocket协议进行实时通信，没有公开的传统REST API接口。客户端与服务器之间的交互遵循自定义协议，主要涉及连接建立、屏幕数据传输以及控制信号交换。具体细节需要查看源码中的实现逻辑，尤其是rendezvous服务器和前端JavaScript代码。

项目安装方式

本节已覆盖在安装指南中，分别详细介绍了通过Docker和非Docker环境部署Screensy的具体步骤。选择适合您场景的部署方法即可完成安装。

---

以上即为Screensy项目的完整技术文档，涵盖了安装、使用、API概述以及特定部署方式的详细信息，帮助您深入了解并快速启用此屏幕共享解决方案。

screensy Simple peer-to-peer screen sharing 项目地址: https://gitcode.com/gh_mirrors/sc/screensy