You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
synctv/README.md

145 lines
5.1 KiB
Markdown

<div align="center">
<a href="https://github.com/synctv-org/docs"><img height="100px" alt="logo" src="https://cdn.jsdelivr.net/gh/synctv-org/docs@main/logo/logo.png"/></a>
<p><em>👫A program that allows you to watch movies/live broadcasts together remotely🍿</em></p>
<div>
<a href="https://goreportcard.com/report/github.com/synctv-org/synctv">
<img src="https://goreportcard.com/badge/github.com/synctv-org/synctv" alt="latest version" />
</a>
<a href="https://github.com/synctv-org/synctv/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/synctv-org/synctv" alt="License" />
</a>
<a href="https://github.com/synctv-org/synctv/actions?query=workflow%3Arelease">
<img src="https://img.shields.io/github/actions/workflow/status/synctv-org/synctv/release.yml?branch=main" alt="Release status" />
</a>
<a href="https://github.com/synctv-org/synctv/releases">
<img src="https://img.shields.io/github/release/synctv-org/synctv" alt="latest version" />
</a>
</div>
<div>
<a href="https://github.com/synctv-org/synctv/releases">
<img src="https://img.shields.io/github/downloads/synctv-org/synctv/total?color=%239F7AEA&logo=github" alt="Downloads" />
</a>
<a href="https://hub.docker.com/r/synctvorg/synctv">
<img src="https://img.shields.io/docker/pulls/synctvorg/synctv?color=%2348BB78&logo=docker&label=pulls" alt="Downloads" />
</a>
</div>
</div>
1 year ago
---
English | [中文](./README-CN.md)
# What is SyncTV?
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
- [x] Theater
- [x] Chat
- [x] Bullet chat
- [x] Proxy
- [x] Videos proxy
- [x] Live proxy
- [x] Proxy cache
4 months ago
- [x] Parse video
- [x] Alist
- [x] Bilibili
- [x] Emby
- [x] Parse live
- [x] Bilibili
- [x] WebRTC online call
- [x] Audio
- [ ] Video
- [ ] Screen
1 year ago
---
1 year ago
# Demo
[https://demo.synctv.wiki](https://demo.synctv.wiki)
1 year ago
---
# 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
sudo -v ; curl -fsSL https://raw.gitmirror.com/synctv-org/synctv/main/script/install.sh | sudo bash -s -- -v latest
```
## Docker
You can also use docker to install and run SyncTV.
```bash
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
1 year ago
`synctv server` to start the server
```bash
synctv server
# or
synctv server --data-dir ./
1 year ago
```
1 year ago
> 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.
>
9 months ago
> 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).
1 year ago
# Documentation
[https://docs.synctv.wiki](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
4 months ago
- [T-rabbit](https://github.com/T-rabbit) ¥ 5
4 months ago
- 矿神SPK源 ¥ 100
1 year ago
# 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.
- Before using the program, you should understand and assume the corresponding risks, including but not limited to copyright disputes, legal restrictions, etc., which are not related to the program.
- 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)