diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 49b4ce6..79075b2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,7 +2,11 @@ name: build on: push: + paths-ignore: + - '**.md' pull_request: + paths-ignore: + - '**.md' concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} diff --git a/README-CN.md b/README-CN.md index 865c742..c4ebc51 100644 --- a/README-CN.md +++ b/README-CN.md @@ -30,13 +30,12 @@ [English](./README.md) | 中文 # 什么是SyncTV? -SyncTV 是一个允许您远程一起观看电影和直播的程序。它提供了同步观看、剧院和代理功能。使用 SyncTV，您可以与朋友和家人一起观看视频和直播，无论他们在哪里。 -SyncTV 的同步观看功能确保所有观看视频的人都在同一点上。这意味着您可以暂停、倒带或快进视频，其他人也会同步到同一点。SyncTV 还支持实时直播，因此您可以一起实时观看直播事件。 - -剧院功能提供了聊天和弹幕功能，让您在观看视频时与朋友和家人交流。代理功能允许您观看在您连接到源服务器缓慢的视频和直播。 +SyncTV 是一个允许您远程一起观看电影和直播的程序。它提供了同步观影、直播、聊天等功能。使用 SyncTV，您可以与朋友和家人一起观看视频和直播，无论他们在哪里。 +SyncTV 的同步观影功能确保所有观看视频的人都在同一点上。这意味着您可以暂停、快进快退、倍速等操作，其他人也会同步到同一点。 # 特点 + - [x] 同步观看 - [x] 视频同步 - [x] 直播同步 @@ -56,14 +55,19 @@ SyncTV 的同步观看功能确保所有观看视频的人都在同一点上。 --- # 演示站点 + https://demo.synctv.wiki --- + # 安装方式 + ## 二进制 + 您可以从[发布页面](https://github.com/synctv-org/synctv/releases)下载最新的二进制文件并手动安装。 ## 一键脚本 + 您可以使用该脚本来安装和运行 SyncTV。 ```bash @@ -71,15 +75,21 @@ sudo -v ; curl -fsSL https://raw.gitmirror.com/synctv-org/synctv/main/script/ins ``` ## Docker + 您也可以使用 docker 安装并运行 SyncTV。 ```bash -docker run -d --name synctv -p 8080:8080 synctvorg/synctv +docker run -d --name synctv -v /opt/synctv:/root/.synctv -p 8080:8080 synctvorg/synctv ``` +## Docker compose + +[docker-compose.yml](./script/docker-compose.yml) + --- # 运行 + `synctv server` 启动服务器 ```bash @@ -89,22 +99,28 @@ synctv server --data-dir ./ ``` > 每次启动会检测是否有root权限的用户，如果没有则会初始化一个`root`用户，密码为`root`，请及时修改用户名密码。 -> +> > 用户注册功能需要启用任意 `OAuth2` 服务，如 `Google`、`Github` 等等，具体配置请参考[文档](https://docs.synctv.wiki/#/zh-cn/oauth2)。 # 文档 + https://docs.synctv.wiki # 特别赞助商 + - [亚洲云](https://www.asiayun.com) 为[演示站](https://demo.synctv.wiki)点提供服务器支持。 - [LucasYuYu](https://github.com/LucasYuYu) ¥ 18.88 +- [爱发电用户_5vDc](https://afdian.com/u/48fa38ce0e0211ef944d5254001e7c00) ¥ 228 +- masha # 贡献者 + 感谢这些出色的人们： [![贡献者](https://contrib.nn.ci/api?repo=synctv-org/synctv&repo=synctv-org/synctv-web&repo=synctv-org/docs)](https://github.com/synctv-org/synctv/graphs/contributors) # 免责声明 + - 这个程序是一个免费且开源的项目。它旨在播放网络上的视频文件，方便多人共同观看视频和学习golang。 - 在使用时，请遵守相关法律法规，不要滥用。 - 该程序仅进行客户端播放视频文件/流量转发，不会拦截、存储或篡改任何用户数据。 @@ -112,4 +128,5 @@ https://docs.synctv.wiki - 如果有任何侵权行为，请通过[电子邮件](mailto:pyh1670605849@gmail.com)与我联系，将及时处理。 # 讨论 -- [Telegram](https://t.me/synctv) \ No newline at end of file + +- [Telegram](https://t.me/synctv) diff --git a/README.md b/README.md index f1a7342..16523fb 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,12 @@ English | [中文](./README-CN.md) # What is SyncTV? -SyncTV is a program that allows you to watch movies and live broadcasts together remotely. It provides synchronized viewing, theater, and proxy features. With SyncTV, you can watch videos and live streams with your friends and family, no matter where they are. -SyncTV's synchronized viewing feature ensures that everyone watching the video is at the same point in the video. This means that you can pause, rewind, or fast-forward the video, and everyone else will be synced to the same point. SyncTV also supports live streaming, so you can watch live events together in real-time. - -The theater feature provides a chat and bullet chat function, allowing you to communicate with your friends and family while watching the video. The proxy feature allows you to watch videos and live streams that may be connect to origin server slow. +SyncTV is a program that allows you to watch movies and live broadcasts together remotely. It provides features such as synchronized viewing, live streaming, and chat. With SyncTV, you can watch videos and live broadcasts with friends and family, no matter where they are. +SyncTV's synchronized viewing feature ensures that everyone watching the video is at the same point. This means that you can pause, fast forward, rewind, change playback speed, and other operations, and everyone else will be synchronized to the same point. # Features + - [x] Synchronized viewing - [x] Videos Sync - [x] Live streaming @@ -56,15 +55,19 @@ The theater feature provides a chat and bullet chat function, allowing you to co --- # Demo -https://demo.synctv.wiki + + --- # Installation + ## Binary + You can download the latest binary from [release page](https://github.com/synctv-org/synctv/releases) and install it manually. ## Script + You can use the script to install and run SyncTV. ```bash @@ -72,15 +75,21 @@ sudo -v ; curl -fsSL https://raw.gitmirror.com/synctv-org/synctv/main/script/ins ``` ## Docker + You can also use docker to install and run SyncTV. ```bash -docker run -d --name synctv -p 8080:8080 synctvorg/synctv +docker run -d --name synctv -v /opt/synctv:/root/.synctv -p 8080:8080 synctvorg/synctv ``` +## Docker compose + +[docker-compose.yml](./script/docker-compose.yml) + --- # Run + `synctv server` to start the server ```bash @@ -90,25 +99,32 @@ synctv server --data-dir ./ ``` > Every time it starts, it will check for users with root permissions. If none are found, it will initialize a `root` user with the password `root`. Please change the username and password promptly. -> +> > The user registration function requires the use of any `OAuth2` service, such as `Google`, `Github`, etc. For specific configuration, please refer to [documentation](https://docs.synctv.wiki/#/oauth2). # Documentation -https://docs.synctv.wiki + + # Special sponsors + - [亚洲云](https://www.asiayun.com) supports the server for the [demo](https://demo.synctv.wiki) site. - [LucasYuYu](https://github.com/LucasYuYu) ¥ 18.88 +- [爱发电用户_5vDc](https://afdian.com/u/48fa38ce0e0211ef944d5254001e7c00) ¥ 228 +- masha # Contributors + Thanks goes to these wonderful people: [![Contributors](https://contrib.nn.ci/api?repo=synctv-org/synctv&repo=synctv-org/synctv-web&repo=synctv-org/docs)](https://github.com/synctv-org/synctv/graphs/contributors) # License + The `SyncTV` is open-source software licensed under the AGPL-3.0 license. # Disclaimer + - This program is a free and open-source project. It aims to play video files on the internet, making it convenient for multiple people to watch videos and learn golang together. - Please comply with relevant laws and regulations when using it, and do not abuse it. - The program only plays video files/forwards traffic on the client-side and will not intercept, store, or tamper with any user data. @@ -116,4 +132,5 @@ The `SyncTV` is open-source software licensed under the AGPL-3.0 license. - If there is any infringement, please contact me via [email](mailto:pyh1670605849@gmail.com), and it will be dealt with promptly. # Discussion -- [Telegram](https://t.me/synctv) \ No newline at end of file + +- [Telegram](https://t.me/synctv)