Skip to content

Commit

Permalink
Docs: update installation
Browse files Browse the repository at this point in the history
  • Loading branch information
zijiren233 committed Oct 9, 2023
1 parent 5ebb14c commit e2aad61
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,27 @@ SyncTV 的同步观看功能确保所有观看视频的人都在同一点上。
- [ ] 视频代理
- [ ] 直播代理

---
# 安装方式
## 二进制
您可以从[发布页面](https://github.com/synctv-org/synctv/releases)下载最新的二进制文件并手动安装。

## 一件脚本
您可以使用该脚本来安装和运行 SyncTV。

```bash
sudo -v ; curl https://raw.githubusercontent.com/synctv-org/synctv/main/install.sh | sudo bash -s -- -v latest
```

## Docker
您也可以使用 docker 安装并运行 SyncTV。

```bash
docker run -d --name synctv -p 8080:8080 synctvorg/synctv
```

有关 docker 镜像的更多信息,请参阅[此处](https://hub.docker.com/r/synctvorg/synctv)

---

# 用法
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,28 @@ The theater feature provides a chat and bullet chat function, allowing you to co

---

# 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 https://raw.githubusercontent.com/synctv-org/synctv/main/install.sh | sudo bash -s -- -v latest
```

## Docker
You can also use docker to install and run SyncTV.

```bash
docker run -d --name synctv -p 8080:8080 synctvorg/synctv
```

More information about docker image, please see [here](https://hub.docker.com/r/synctvorg/synctv).

---

# Usage
## Global Flags:

Expand Down
3 changes: 2 additions & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ download_tools_list=(
)

function Help() {
echo "Usage: sudo -v ; curl https://raw.githubusercontent.com/synctv-org/synctv/main/install.sh | sudo bash"
echo "Usage: sudo -v ; curl https://raw.githubusercontent.com/synctv-org/synctv/main/install.sh | sudo bash -s -- -v latest"
echo "-h: help"
echo "-v: install version (default: latest)"
}
Expand Down Expand Up @@ -138,6 +138,7 @@ function InstallVersion() {
cd "$tmp_dir"
trap 'rm -rf "$tmp_dir"' EXIT

echo "download: https://github.com/synctv-org/synctv/releases/download/$1/synctv-${OS}-${ARCH}"
Download "https://github.com/synctv-org/synctv/releases/download/$1/synctv-${OS}-${ARCH}" "synctv"

case "$OS" in
Expand Down

0 comments on commit e2aad61

Please sign in to comment.