Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zmisgod committed Aug 31, 2024
1 parent 7463cb3 commit d3a38b9
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 78 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/desktop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ jobs:
with:
node-version: 18

- name: Checkout iptv-checker-web
- name: Checkout iptv-checker-ui-interface
uses: actions/checkout@v4
with:
repository: zhimin-dev/iptv-checker-web
path: iptv-checker-web
repository: zhimin-dev/iptv-checker-ui-interface
path: iptv-checker-ui-interface

- name: install Rust stable
uses: actions-rs/toolchain@v1
Expand All @@ -70,7 +70,7 @@ jobs:
sudo apt-get install -y webkit2gtk-4.0
- name: install app dependencies and build it
working-directory: ./iptv-checker-web
working-directory: ./iptv-checker-ui-interface
run: yarn && yarn build

- uses: tauri-apps/tauri-action@v0
Expand All @@ -81,7 +81,7 @@ jobs:

- name: Build archive
shell: bash
working-directory: ./iptv-checker-web
working-directory: ./iptv-checker-ui-interface
run: |
binaryName="iptv-checker-desktop"
gitTagName="${{github.ref_name}}"
Expand Down Expand Up @@ -134,4 +134,4 @@ jobs:
uses: softprops/action-gh-release@v1
with:
files: |
./iptv-checker-web/${{ env.ASSET }}
./iptv-checker-ui-interface/${{ env.ASSET }}
2 changes: 1 addition & 1 deletion .github/workflows/docker-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
echo ::set-output name=tags::${TAGS}
mkdir iptv-checker && cp dockerfile iptv-checker/dockerfile
git clone https://github.com/zhimin-dev/iptv-checker-rs.git
git clone https://github.com/zhimin-dev/iptv-checker-web.git
git clone https://github.com/zhimin-dev/iptv-checker-ui-interface.git
- name: Setup Docker Buildx Command
id: buildx
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
echo ::set-output name=tags::${TAGS}
mkdir iptv-checker && cp dockerfile iptv-checker/dockerfile
git clone https://github.com/zhimin-dev/iptv-checker-rs.git
git clone https://github.com/zhimin-dev/iptv-checker-web.git
git clone https://github.com/zhimin-dev/iptv-checker-ui-interface.git
- name: Setup Docker Buildx Command
id: buildx
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ all: migrate

migrate:
rm -rf ../iptv-checker-rs/web/
cp -rf ../iptv-checker-web/dist/ ../iptv-checker-rs/web/
cp -rf ../iptv-checker-ui-interface/dist/ ../iptv-checker-rs/web/
46 changes: 12 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,16 @@
<img alt="iptv-checker" src="https://github.com/zhimin-dev/iptv-checker-web/blob/main/src/assets/icon.png" height=80>
<img alt="iptv-checker" src="https://github.com/zhimin-dev/iptv-checker/blob/main/icon.png" height=80>

[中文版本](https://github.com/zhimin-dev/iptv-checker/blob/main/cn.md)

# iptv-checker
## iptv-checker

This project is split into 2 projects
IPTV checker tool for Docker && Desktop && CMD, check your playlist is available

- Frontend [iptv-checker-web:v4.0.1](https://github.com/zhimin-dev/iptv-checker-web), providing the backend page for iptv-checker
- Backend [iptv-checker-rs:v4.0.1](https://github.com/zhimin-dev/iptv-checker-rs), providing cmd commands and web API for IPTV
- For container versions, go to the [docker hub](https://hub.docker.com/r/zmisgod/iptvchecker) page to find the relevant commands

## Docker Local Packaging
- In command-line mode, go to [GitHub's release page](https://github.com/zhimin-dev/iptv-checker/releases) and look for the download file with a version number that starts with `v`(default version)

First, clone the following 3 projects to your local machine (for example, place them in a node folder). Below is an example of the folder structure.

- node
- iptv-checker
- iptv-checker-web
- iptv-checker-rs

```bash
# Enter the node folder
cd node

# Execute build
docker build -f iptv-checker/dockerfile -t ipserver .

# Run
docker run -d -p 8081:8089 --name myIp ipserver

# Alternatively, specify the port (this time specifying the port as 10001, you need to change the two 10001 places below), output file mapping to local directory
docker run -d -p 8081:10001 -e WEB_PORT=10001 -v ~/icStatic/output:/app/static/output --name myIp ipserver
```
- For the desktop version, please go to [GitHub's release page](https://github.com/zhimin-dev/iptv-checker/releases) and look for the download file with a version number that starts with `d`(means desktop)

### Docker Official Package Usage

Expand All @@ -40,19 +20,15 @@ Run the docker version of iptv-checker with the following commands

```bash
docker pull zmisgod/iptvchecker

docker run -d -p 8081:8089 --name myIp zmisgod/iptvchecker

# Alternatively, specify the port (this time specifying the port as 10001, you need to change the two 10001 places below), output file mapping to local directory
docker run -d -p 8081:10001 -e WEB_PORT=10001 -v ~/icStatic/output:/app/static/output --name myIp ipserver
```

Then open your browser and visit `http://127.0.0.1:8081/`.

### Docker Local Multi-Platform Package Method

```bash
docker buildx create --name mybuilder
docker buildx inspect --bootstrap
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t zmisgod/iptvchecker:latest --push -f iptv-checker/dockerfile .
```

### Docker-Compose Deployment

```bash
Expand All @@ -61,6 +37,8 @@ docker-compose up -d

## Changelog

- v4.0.2
- fixed the issue that it could not be played on the Windows platform
- v4.0.1
- Bug Fixes
- Issue with the source input box not recognizing data
Expand Down
48 changes: 14 additions & 34 deletions cn.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,16 @@
<img alt="iptv-checker" src="https://github.com/zhimin-dev/iptv-checker-web/blob/main/src/assets/icon.png" height=80>
<img alt="iptv-checker" src="https://github.com/zhimin-dev/iptv-checker/blob/main/icon.png" height=80>

[English Version](https://github.com/zhimin-dev/iptv-checker/blob/main/README.md)

# iptv-checker
## iptv-checker

本项目拆成2个项目
适用于Docker & Desktop & & CMD的IPTV检查工具,请检查您的播放列表是否可用

- 前端[iptv-checker-web:v4.0.1](https://github.com/zhimin-dev/iptv-checker-web),提供iptv-checker后台页面
- 后端[iptv-checker-rs:v4.0.1](https://github.com/zhimin-dev/iptv-checker-rs),提供iptv的cmd命令以及web api
- 对于容器版本,请前往 [docker hub](https://hub.docker.com/r/zmisgod/iptvchecker) 页面查找相关命令

## docker本地打包
- 在命令行模式下,转到 [GitHub 的发布页面](https://github.com/zhimin-dev/iptv-checker/releases) 并查找版本号以 'v' 开头的下载文件

先将下面3个项目clone到本地(比如放在node文件夹下),下面为文件夹目录示例

- node
- iptv-checker
- iptv-checker-web
- iptv-checker-rs

```bash
# 进入node文件夹
cd node

# 执行build
docker build -f iptv-checker/dockerfile -t ipserver .

# 运行
docker run -d -p 8081:8089 --name myIp ipserver

# 或者指定端口(本次指定端口为 10001,下面2个10001的地方都需要改动)、输出文件映射本地目录
docker run -d -p 8081:10001 -e WEB_PORT=10001 -v ~/icStatic/output:/app/static/output --name myIp ipserver
```
- 对于桌面版本,请前往 [GitHub 的发布页面](https://github.com/zhimin-dev/iptv-checker/releases) 并查找版本号以 'd' 开头的下载文件

### Docker官方包使用方法

Expand All @@ -39,20 +19,18 @@ docker run -d -p 8081:10001 -e WEB_PORT=10001 -v ~/icStatic/output:/app/static/o
按照下面的命令运行docker版本的iptv-checker

```bash
# 拉取镜像
docker pull zmisgod/iptvchecker

# 运行镜像
docker run -d -p 8081:8089 --name myIp zmisgod/iptvchecker

# 或者指定端口(本次指定端口为 10001,下面2个10001的地方都需要改动)、输出文件映射本地目录
docker run -d -p 8081:10001 -e WEB_PORT=10001 -v ~/icStatic/output:/app/static/output --name myIp ipserver
```

再打开浏览器访问`http://127.0.0.1:8081/`即可

### Docker本地打多平台包方法

```bash
docker buildx create --name mybuilder
docker buildx inspect --bootstrap
docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t zmisgod/iptvchecker:latest --push -f iptv-checker/dockerfile .
```

### Docker-Compose 部署

```bash
Expand All @@ -61,6 +39,8 @@ docker-compose up -d

## 更新日志

- v4.0.2
- 修复windows平台无法播放的问题
- v4.0.1
- bug修复
- 检测源输入框无法识别数据问题
Expand Down
2 changes: 1 addition & 1 deletion dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ FROM debian:buster-slim as frontend-builder
# 设置工作目录
WORKDIR /usr/src/app
# 复制前端代码
COPY iptv-checker-web/dist ./frontend
COPY iptv-checker-ui-interface/dist ./frontend

# 后端构建阶段
FROM rust:latest as backend-builder
Expand Down
Binary file added icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d3a38b9

Please sign in to comment.