Skip to content

Commit

Permalink
Update: [Readme.md] ドキュメントを更新
Browse files Browse the repository at this point in the history
  • Loading branch information
tsukumijima committed Apr 26, 2023
1 parent b0ccfe8 commit 5c24a3c
Showing 1 changed file with 29 additions and 30 deletions.
59 changes: 29 additions & 30 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@
- [Linux](#linux)
- [Tailscale の導入](#tailscale-の導入)
- [サーバーのインストール](#サーバーのインストール)
- [KonomiTV (β) 0.5.2 以前からのアップグレード](#konomitv-β-052-以前からのアップグレード)
- [KonomiTV (β) 0.6.0-dev (開発版) からのアップグレード](#konomitv-β-060-dev-開発版-からのアップグレード)
- [Windows](#windows-1)
- [Linux](#linux-1)
- [KonomiTV にアクセスする](#konomitv-にアクセスする)
- [KonomiTV (β) 0.5.2 以前からのアップグレード](#konomitv-β-052-以前からのアップグレード)
- [KonomiTV (β) 0.6.0-dev (開発版) からのアップグレード](#konomitv-β-060-dev-開発版-からのアップグレード)
- [付録](#付録)
- [`https://aa-bb-cc-dd.local.konomi.tv:7000/` の URL について](#httpsaa-bb-cc-ddlocalkonomitv7000-の-url-について)
- [設定ファイルの編集](#設定ファイルの編集)
Expand Down Expand Up @@ -72,7 +72,6 @@
当然ながら表に泥臭い処理を見せないようにしている分、裏側の実装がそれなりに大変です。細かいところまで調整しているとかなりの手間がかかります。
それでも私が頑張れば私を含めたユーザーの視聴体験が向上するわけで、必要な犠牲かなと思っています。


<img width="100%" src="https://user-images.githubusercontent.com/39271166/153731898-c9743df8-794b-4498-ac25-017662f38759.png"><br>

## 動作環境
Expand Down Expand Up @@ -140,10 +139,10 @@
- コメントを多めに書いたりそれなりにきれいにコーディングしているつもりなので、少なくとも TVRemotePlus なんかよりかは読みやすいコードになっている…はず。
- 他人が見るために書いたものではないのであれですが、一応自分用の [開発資料](https://mango-garlic-eff.notion.site/KonomiTV-90f4b25555c14b9ba0cf5498e6feb1c3)[DB設計](https://mango-garlic-eff.notion.site/KonomiTV-544e02334c89420fa24804ec70f46b6d) 的なメモを公開しておきます。もし PR される場合などの参考になれば。

## 事前準備

<img width="100%" src="https://user-images.githubusercontent.com/39271166/153729029-bbcd6c16-9661-4f61-b7a9-64df8c1e4586.png"><br>

## 事前準備

### チューナーのドライバーを px4_drv に変更する

必須ではありませんが、**Windows で PLEX 製チューナーを利用している場合は、事前にドライバーを [px4_drv for WinUSB](https://github.com/tsukumijima/px4_drv) に変更しておくことを強く推奨します。**
Expand Down Expand Up @@ -302,27 +301,9 @@ KonomiTV を共有したい家族や親戚に Tailscale アカウントを作成
**KonomiTV での利用以外にも、EDCB Material WebUI や EPGStation などの、プライベートネットワーク上の Web サーバーに家の外からアクセスするときにとても便利なサービスです。**
20台までは無料ですし (逸般の誤家庭でなければ十分すぎる)、この機会に導入しておくことをおすすめします。

## サーバーのインストール

<img width="100%" src="https://user-images.githubusercontent.com/39271166/201460497-7f0b951a-5495-40cd-95af-32cc2146d991.png"><br>

### KonomiTV (β) 0.5.2 以前からのアップグレード

KonomiTV 0.5.2 以前のバージョンをすでにインストールしている場合、**直接 0.5.2 から 0.6.0 以降にアップグレードすることはできません。** 各種構成に破壊的な変更を多数行ったため、KonomiTV 0.5.2 と 0.6.0 以降には互換性がないためです。

お手数ですが、**一度 0.5.2 をインストールしているフォルダを丸ごと削除した上で、新しく 0.6.0 以降をインストールし直してください。**

また、KonomiTV 0.6.0-dev 以降のバージョンでは、ポータブル版の Python をサードパーティーライブラリに組み込んでいます。そのため、Python 3.9 / 3.10 を別途インストールする必要はなくなりました。
不要であれば適宜アンインストールしてください(残しておいても動作に支障はありません)。

### KonomiTV (β) 0.6.0-dev (開発版) からのアップグレード

**0.6.0 の正式リリース前に公開していた [ベータ版インストーラー](https://github.com/tsukumijima/Storehouse/releases/tag/KonomiTV-Installer-Prerelease) で KonomiTV 0.6.0-dev (master ブランチの開発版) をインストールしている場合は、0.6.0 以降の正式版のインストーラーを使って、0.6.0 以降にアップグレードできます。**

ただし、ベータ版インストーラーの初期リビジョンでインストールした場合は構成に不備があるほか、100% アップグレードが成功する保証もありません。
心配な方は、**一度インストーラーでアンインストールしてから、新しく 0.6.0 以降をインストールし直すことをおすすめします。**

> KonomiTV 0.6.0-dev 以降のバージョンでは、Windows サービスや PM2 / Docker サービスのインストール処理が追加されています。そのため、単にフォルダを削除するだけではアンインストールできません。
## サーバーのインストール

### Windows

Expand Down Expand Up @@ -350,7 +331,7 @@ Assets の下にある `KonomiTV-Installer.exe` をダウンロードしてく
### Linux

[動作環境] に記載のとおり、Ubuntu 20.04 LTS 以降の OS にのみ対応しています。
[動作環境] に記載のとおり、Ubuntu 20.04 LTS / Debian 11 Bullseye 以降の OS にのみ対応しています。
それ以外のディストリビューションでも動くかもしれませんが、動作は保証しませんし、今後のサポート予定もありません(Docker ならどの OS でもそれなりに動くような気はします)。

> できるだけ Ubuntu の利用を推奨しますが、もし Ubuntu 以外の OS にインストールする際は、Docker でのインストールをおすすめします。
Expand Down Expand Up @@ -415,10 +396,28 @@ KonomiTV サーバーは Windows サービス (Windows) / PM2 サービス (Linu

> [PWA (Progressive Web Apps)](https://developer.mozilla.org/ja/docs/Web/Progressive_web_apps) という、Web アプリを通常のネイティブアプリのように使えるようにする技術を利用しています。将来的には、PWA だけでなく、より快適に利用できるようにした iOS 向けアプリと Android 向けアプリ (いわゆるガワアプリ) をリリースする予定です。
## 付録
### KonomiTV (β) 0.5.2 以前からのアップグレード

KonomiTV 0.5.2 以前のバージョンをすでにインストールしている場合、**直接 0.5.2 から 0.6.0 以降にアップグレードすることはできません。** 各種構成に破壊的な変更を多数行ったため、KonomiTV 0.5.2 と 0.6.0 以降には互換性がないためです。

お手数ですが、**一度 0.5.2 をインストールしているフォルダを丸ごと削除した上で、新しく 0.6.0 以降をインストールし直してください。**

また、KonomiTV 0.6.0-dev 以降のバージョンでは、ポータブル版の Python をサードパーティーライブラリに組み込んでいます。そのため、Python 3.9 / 3.10 を別途インストールする必要はなくなりました。
不要であれば適宜アンインストールしてください(残しておいても動作に支障はありません)。

### KonomiTV (β) 0.6.0-dev (開発版) からのアップグレード

**0.6.0 の正式リリース前に公開していた [ベータ版インストーラー](https://github.com/tsukumijima/Storehouse/releases/tag/KonomiTV-Installer-Prerelease) で KonomiTV 0.6.0-dev (master ブランチの開発版) をインストールしている場合は、0.6.0 以降の正式版のインストーラーを使って、0.6.0 以降にアップグレードできます。**

ただし、ベータ版インストーラーの初期リビジョンでインストールした場合は構成に不備があるほか、100% アップグレードが成功する保証もありません。
心配な方は、**一度インストーラーでアンインストールしてから、新しく 0.6.0 以降をインストールし直すことをおすすめします。**

> KonomiTV 0.6.0-dev 以降のバージョンでは、Windows サービスや PM2 / Docker サービスのインストール処理が追加されています。そのため、単にフォルダを削除するだけではアンインストールできません。
<img width="100%" src="https://user-images.githubusercontent.com/39271166/153728655-afe25279-2d42-4150-bfdf-71de62dde44d.jpg"><br>

## 付録

### `https://aa-bb-cc-dd.local.konomi.tv:7000/` の URL について

**この `https://aa-bb-cc-dd.local.konomi.tv:7000/` のフォーマットの URL は、KonomiTV の WebUI に HTTPS でアクセスするための特殊な URL です。**
Expand Down Expand Up @@ -636,10 +635,10 @@ URL が少し長いので、適宜ブックマークやホーム画面に追加
- ただし、サーバー PC の GPU が H.265 / HEVC でのハードウェアエンコードに対応している必要があります。視聴開始時に「H.265/HEVC でのエンコードに対応していません」というエラーメッセージが表示された場合は、通信節約モードは使えません。
- 通信節約モードのオン/オフは [設定][全般] から変更できます。

## 開発者向け情報

<img width="100%" src="https://user-images.githubusercontent.com/39271166/201457873-dab7a1cb-667f-4bcd-8843-231850d05689.png"><br>

## 開発者向け情報

開発環境は VS Code です。
開発時に推奨する拡張機能は [.vscode/extensions.json](https://github.com/tsukumijima/KonomiTV/blob/master/.vscode/extensions.json) に記述されています。

Expand Down Expand Up @@ -675,10 +674,10 @@ API サーバーは別のポート (7000) でリッスンされているので
クライアントの静的ファイルは、`client/dist/` に配置されているビルド済みのものをサーバー側で配信するように設定されています。
そのため、`yarn build` でクライアントのビルドを更新したのなら、サーバー側で配信されるファイルも同時に更新されることになります。

## 寄付・支援について

<img width="100%" src="https://user-images.githubusercontent.com/39271166/201461029-2f75a38f-928c-4f23-8552-e2d845d67365.jpg"><br>

## 寄付・支援について

とてもありがたいことに私に寄付したいという方が複数いらっしゃったので、**今のところ [アマギフ (Amazon ギフト券)](https://www.amazon.co.jp/b?node=3131877051&tag=tsukumijima-22) だけ受けつけています。**

特典などは今のところありませんが、それでも寄付していただけるのであれば、アマギフの URL を [Twitter の DM (クリックすると DM が開きます)](https://twitter.com/messages/compose?recipient_id=1194724304585248769)`tvremoteplusあっとgmail.com` まで送っていただけると、大変開発の励みになります…🙏🙏🙏
Expand Down

0 comments on commit 5c24a3c

Please sign in to comment.