{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/568", "result": {"data":{"issuesJson":{"id":"08a353fc-1f33-5bc6-b8d4-351caf78fea5","title":"tl-open-source/tl-rtc-file: 基于 WebRTC 的媒体流传输工具","number":568,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Repostl-open-source/tl-rtc-file
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

tl-rtc-file-tool (tl webrtc file(media) tools)

\n

\"\"
\n\"\"
\n\"\"
\n\"\"
\n\"\"

\n

\nDemo ｜\nDocument ｜\nDockerHub ｜\n中文文档 ｜ QQ Group:\n624214498\n

\n

Table of Contents

\n\n

Background

\n

This project was developed based on the topic of the graduation project in 2020. It allows file transfer using WebRTC in web applications and supports transferring large files.

\n

Advantages

\n

Fragmented transmission, cross-platform, platform-independent, easy to use, no speed limit in the local network (up to over 70 MB/s in the LAN), supports private deployment, supports drag-and-drop sending of multiple files, web file preview. Many additional features have been added, such as local screen recording, remote screen sharing (zero-latency), remote audio and video calls (zero-latency), live streaming (zero-latency), password-protected rooms, OSS cloud storage, relay service settings, WebRTC detection, WebRTC statistics, text transmission (group chat, private chat), public chat, remote whiteboard, AI chatbox, feature-rich admin panel, real-time execution log display, robot alert notifications, and more.

\n

Pre-deployment Considerations

\n

Whether it's self-deployment, Docker deployment, or other script deployments, you need to modify the corresponding configurations in tlrtcfile.env before performing the following operations. Further configuration modifications and service restarts are required.

\n

Of course, you can also use the default configurations without modifications, but the default configurations are only suitable for testing on localhost. They won't be accessible to others, making it impossible for others to use. Therefore, if you intend to deploy on a server for local network or public network users, you must configure tlrtcfile.env accordingly.

\n

Self-Deployment

\n

Installing Dependencies

\n

Install Node.js 14.21.x or above, and npm. Then, navigate to the project directory and run the following command:

\n
cd svr/\n\nnpm install\n
\n

For the first run, execute the following command:

\n
npm run build:pro\n
\n

If you need to develop or modify the frontend pages, use this command. If not, you can skip this step:

\n
npm run build:dev\n
\n

Starting the Service

\n

Start the following two services. Choose one mode to start. The only difference between them is that the HTTPS mode is required to use features like audio/video streaming, live streaming, and screen sharing. Other features are not affected.

\n

After starting in HTTP mode, access the service at http://your_machine_ip:9092.

\n\n
npm run http-api\nnpm run http-socket\n
\n

Or, start in HTTPS mode and access the service at https://your_machine_ip:9092.

\n\n
npm run https-api\nnpm run https-socket\n
\n

Docker Deployment

\n

Currently, both official images and self-built images are supported. For official images, there are two ways to operate: docker script startup and docker-compose startup.

\n

One-Click Docker Script

\n

Navigate to the bin/ directory and execute the auto-pull-and-start-docker.sh script:

\n
chmod +x ./auto-pull-and-start-docker.sh\n./auto-pull-and-start-docker.sh\n
\n

Using docker-compose

\n

In the main directory, execute the corresponding command based on your Docker Compose version:

\n\n
docker-compose --profile=http up -d\n
\n\n
docker compose --profile=http up -d\n
\n

Self-Building and Starting the Image

\n

Navigate to the docker/ directory and execute the corresponding command based on your Docker Compose version:

\n\n
docker-compose -f docker-compose-build-code.yml up -d\n
\n\n
docker compose -f docker-compose-build-code.yml up -d\n
\n

Other Deployment Methods

\n

In addition to the manual installation, Docker official images, and self-built Docker images, there are other methods such as automatic scripts and one-click deployments on hosting platforms.

\n

After downloading the project, navigate to the bin/ directory and choose the appropriate system script to execute. It will automatically detect the environment, install dependencies, and start the service.

\n

Automatic script for Ubuntu (e.g., Ubuntu 16)

\n\n
chmod +x ./ubuntu16/*.sh\n
\n\n
./auto-check-install-http.sh\n
\n\n
./auto-check-install-https.sh\n
\n\n
./auto-stop.sh\n
\n

Automatic script for Windows

\n\n
windows/auto-check-install-http.bat\n
\n\n
windows/auto-check-install-https.bat\n
\n

One-Click Deployment on Zeabur Platform

\n

\"Deploy

\n

Other Configuration Options

\n

Configuring the Database (Optional)

\n

You need to install MySQL database manually, create a database named webchat, and then modify the database-related configurations in tlrtcfile.env.

\n

Admin Panel (Optional)

\n

Prerequisite: Database configuration must be enabled.

\n

Modify the admin panel-related configurations in tlrtcfile.env. After starting, enter the configured room number and password to access the admin panel.

\n

WeChat Notifications (Optional)

\n

If you need to set up notification for access and error alerts, you can create a WeChat Work robot and get an API key. Modify the WeChat notification configurations in tlrtcfile.env.

\n

OSS Cloud Storage (Optional)

\n

The project currently supports Seafile storage integration, and future updates will include support for Alibaba Cloud, Tencent Cloud, Qiniu Cloud, and self-hosted server storage methods. Modify the OSS storage configurations in tlrtcfile.env.

\n

Chat-GPT (Optional)

\n

Integrated with the OpenAI API, this project includes a chat dialog. Modify the OpenAI configurations in tlrtcfile.env.

\n

Configuring turnserver (Optional for LAN, Required for WAN)

\n

There are two ways to generate TURN server credentials: fixed credentials (recommended) and time-limited credentials. Choose one method. The following example uses Ubuntu.

\n

Install coturn:

\n
sudo apt-get install coturn\n
\n

For time-limited credentials, modify the configuration file docker/coturn/turnserver-with-secret-user.conf.

\n\n
`listening-device`, `listening-ip`, `external-ip`, `static-auth-secret`, `realm`\n
\n\n
turnserver -c /path/to/conf/turn/turnserver-with-secret-user.conf\n
\n

For fixed credentials, modify the configuration file docker/coturn/turnserver-with-fixed-user.conf.

\n\n
`listening-device`, `listening-ip`, `external-ip`, `user`, `realm`\n
\n\n
turnadmin -a -u username -p password -r realm_in_config_file\n
\n\n
turnserver -c /path/to/docker/coturn/turnserver-with-secret-user.conf\n
\n

After setting up coturn, configure the WebRTC-related information in the corresponding tlrtcfile.env configuration.

\n

Overview Diagram

\n

\"image\"

\n

License

\n

MIT License Copyright (c) 2020 ~ 2023 iamtsm

\n

Disclaimer

\n

Disclaimer

","updatedAt":"2025-05-22T01:51:10Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"文件管理系统","color":"0eb870"}},{"node":{"name":"tl-open-source","color":"2216bb"}}]},"comments":{"edges":[]}}},"pageContext":{"number":568,"previous":{"title":"tl-open-source/tl-ops-manage: 基于 OpenResty 的 API 网关，支持负载均衡，健康检查，服务熔断，服务限流，WAF 过滤，黑白名单，动态 SSL 证书，自定义插件，多级缓存，可视化管理，动态配置，动态插拔插件，数据统计，数据展示，集群部署","number":567},"next":{"title":"stepchowfun/toast: 一个基于名为 toastfile 的 YAML 文件中定义任务，用于容器化工作流程的工具。","number":569}}}, "staticQueryHashes": ["151096407","2861350382"]}