Oryx开发者快速入门

Oryx 开发者快速入门

精简版快速入门，只保留核心概念与上手步骤。Docker 进阶、端口与数据卷、架构与协议、AI 功能、API 等详见 Oryx完整文档.md。

目录

1. 一句话了解 Oryx
2. 核心概念（组件与数据流）
3. 技术栈一览
4. 5 分钟上手（Docker）
5. 数据目录与持久化
6. 端口与访问
7. 核心功能速览
8. 学习路径与下一步
9. 常见问题

1. 一句话了解 Oryx

Oryx（原 SRS Stack）是一款一体化、开箱即用的开源视频解决方案：在 Docker 里集成 SRS 媒体服务器、Go 后端、React 前端、Redis、FFmpeg 与可选 AI（OpenAI），专为直播 + WebRTC的在线视频服务设计，支持云部署与自托管。

为什么用 Oryx？

• 一体化：推流、转码、多协议播放、管理界面、录制、多平台转发、AI 转录/配音等一站搞定
• 开箱即用：单容器部署，一条docker run即可跑通
• 协议全：RTMP、WebRTC、HLS、HTTP-FLV、SRT；并带 DVR、虚拟直播、RESTful API

2. 核心概念（组件与数据流）

关键组件：

• SRS 5.0：媒体服务器，负责 RTMP、WebRTC、HLS、HTTP-FLV、SRT
• Go 后端：服务编排、HTTP API、认证、流管理
• React 前端：Web 管理界面、配置、监控
• Redis：会话、流状态、元数据
• FFmpeg：转码、虚拟直播、格式转换
• OpenAI API（可选）：转录、配音、OCR、AI 辅助

3. 技术栈一览

4. 5 分钟上手（Docker）

4.1 前提

• 已安装Docker
• 可选：FFmpeg 或 OBS（推流测试）、浏览器（管理界面与播放）

4.2 启动 Oryx

dockerrun --restart always -d -it --name oryx -v$HOME/data:/data\-p80:2022 -p443:2443 -p1935:1935 -p8000:8000/udp -p10080:10080/udp\ossrs/oryx:5

• -v $HOME/data:/data：持久化配置、录制、Redis、上传文件等，生产环境务必保留
• -p 80:2022：HTTP 管理界面（主机 80 → 容器 2022）
• -p 443:2443：HTTPS
• -p 1935:1935：RTMP
• -p 8000:8000/udp、-p 10080:10080/udp：WebRTC

4.3 验证

浏览器打开http://localhost（或本机 IP），应看到 Oryx 管理界面。按界面引导创建应用/流、获取推流地址与播放地址。

4.4 推流与播放

• 推流：使用 OBS 或 FFmpeg 推 RTMP 到rtmp://服务器:1935/应用/流名（具体地址以管理界面为准）
• 播放：在管理界面或播放器中使用 HLS/HTTP-FLV/WebRTC 播放地址

生产环境请配置 HTTPS、防火墙与访问控制（见完整文档中的「端口配置与网络」章节）。

5. 数据目录与持久化

Oryx 使用/data下的子目录做持久化，挂载时务必保留：

6. 端口与访问

具体端口映射以你实际-p为准；防火墙与云安全组需放行上述端口。

7. 核心功能速览

流媒体协议：RTMP（推流/播放）、WebRTC（超低延迟）、HLS、HTTP-FLV、SRT

高级能力：多平台转发（YouTube/Twitch/Facebook）、直播录制（DVR）、FFmpeg 流转码、虚拟直播、AI 转录/配音/OCR

管理与安全：Web 管理界面、认证、自动 HTTPS（Let’s Encrypt）、RESTful OpenAPI

8. 学习路径与下一步

1. 快速开始：用 Docker 部署第一个 Oryx 实例（本文）
2. Docker 部署指南：容器配置与数据持久化
3. 端口配置与网络：防火墙与网络要求
4. 数据卷管理：持久化存储正确配置
5. 架构概览 / 平台服务 / React 前端：扩展与定制开发

以上进阶内容均可在 Oryx完整文档.md 中按章节查阅。

9. 常见问题

提示：Oryx 与纯 SRS 不同，是「SRS + 管理平台 + 业务后端」的一体化方案；若只需裸流媒体服务器可考虑 SRS 单独部署。