mirakurun 4.0.0-beta.1 → 4.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/doc/Configuration.md +10 -10
- package/doc/Platforms.md +50 -3
- package/docker/README.md +5 -3
- package/package.json +1 -2
package/doc/Configuration.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
## server.yml
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
* Env: `SERVER_CONFIG_PATH`
|
|
10
|
+
* Docker Host (default): `/opt/mirakurun/config/server.yml`
|
|
11
|
+
* Linux (legacy): `/usr/local/etc/mirakurun/server.yml`
|
|
12
12
|
|
|
13
13
|
### Structure
|
|
14
14
|
|
|
@@ -31,7 +31,7 @@ allowIPv4CidrRanges: ["10.0.0.0/8", "127.0.0.0/8", "172.16.0.0/12", "192.168.0.0
|
|
|
31
31
|
allowIPv6CidrRanges: ["fc00::/7"] # array of string
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
### Environment
|
|
34
|
+
### Environment Variables (Docker)
|
|
35
35
|
|
|
36
36
|
```sh
|
|
37
37
|
HOSTNAME
|
|
@@ -51,9 +51,9 @@ ALLOW_IPV6_CIDR_RANGES
|
|
|
51
51
|
|
|
52
52
|
## tuners.yml
|
|
53
53
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
54
|
+
* Env: `TUNERS_CONFIG_PATH`
|
|
55
|
+
* Docker Host (default): `/opt/mirakurun/config/tuners.yml`
|
|
56
|
+
* Linux (legacy): `/usr/local/etc/mirakurun/tuners.yml`
|
|
57
57
|
|
|
58
58
|
### Structure
|
|
59
59
|
|
|
@@ -97,9 +97,9 @@ sudo npm install arib-b25-stream-test -g --unsafe-perm
|
|
|
97
97
|
|
|
98
98
|
## channels.yml
|
|
99
99
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
100
|
+
* Env: `CHANNELS_CONFIG_PATH`
|
|
101
|
+
* Docker Host (default): `/opt/mirakurun/config/channels.yml`
|
|
102
|
+
* Linux (legacy): `/usr/local/etc/mirakurun/channels.yml`
|
|
103
103
|
|
|
104
104
|
### Structure
|
|
105
105
|
|
package/doc/Platforms.md
CHANGED
|
@@ -2,15 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
**Bold** is the recommended.
|
|
5
|
+
**Bold** is the recommended.
|
|
6
6
|
|
|
7
7
|
* [**Docker on Linux**](#docker-on-linux)
|
|
8
8
|
* [Docker Engine](https://docs.docker.com/engine/install/) `>=18.06.0`
|
|
9
9
|
* [Docker Compose](https://docs.docker.com/compose/install/) `>=1.22.0`
|
|
10
10
|
* **x64** / arm32v7 / **arm64v8**
|
|
11
|
-
* **Ubuntu Server
|
|
11
|
+
* **Ubuntu Server 24.10** / etc.
|
|
12
12
|
* ⚠ Note: Desktop Environment / VM is not supported and unstable!
|
|
13
13
|
|
|
14
|
+
* [Linux w/ PM2 (legacy)](#linux-w-pm2-legacy)
|
|
15
|
+
* git
|
|
16
|
+
* [Node.js](https://nodejs.org/en/download) `^18 || ^20 || ^22`
|
|
17
|
+
* [PM2](https://pm2.keymetrics.io/)
|
|
18
|
+
|
|
14
19
|
## Docker on Linux
|
|
15
20
|
|
|
16
21
|
**Note:**
|
|
@@ -20,7 +25,7 @@
|
|
|
20
25
|
* PT2/PT3/PX-* users: Use default DVB driver instead of chardev driver.
|
|
21
26
|
* please uninstall chardev drivers then reboot before install.
|
|
22
27
|
|
|
23
|
-
### Docker
|
|
28
|
+
### Install Docker Engine
|
|
24
29
|
|
|
25
30
|
```sh
|
|
26
31
|
# for new machine
|
|
@@ -148,3 +153,45 @@ $ cp /usr/local/bin/something-static /opt/mirakurun/opt/bin/
|
|
|
148
153
|
* Opt: `/opt/mirakurun/opt/`
|
|
149
154
|
* `bin/`
|
|
150
155
|
* `bin/startup` - custom startup script (optional)
|
|
156
|
+
|
|
157
|
+
## Linux w/ PM2 (legacy)
|
|
158
|
+
|
|
159
|
+
This is not recommended.
|
|
160
|
+
The code related to PM2 has already been removed and is not confirmed to work.
|
|
161
|
+
|
|
162
|
+
```sh
|
|
163
|
+
git clone git@github.com:Chinachu/Mirakurun.git
|
|
164
|
+
cd Mirakurun
|
|
165
|
+
|
|
166
|
+
npm install
|
|
167
|
+
npm run build
|
|
168
|
+
|
|
169
|
+
npm install pm2 -g
|
|
170
|
+
pm2 startup
|
|
171
|
+
|
|
172
|
+
# start
|
|
173
|
+
pm2 start processes.json
|
|
174
|
+
pm2 save
|
|
175
|
+
|
|
176
|
+
# stop
|
|
177
|
+
pm2 stop processes.json
|
|
178
|
+
pm2 save
|
|
179
|
+
|
|
180
|
+
# uninstall
|
|
181
|
+
pm2 delete processes.json
|
|
182
|
+
pm2 save
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### 💡 Locations
|
|
186
|
+
|
|
187
|
+
* Socket: `/var/run/mirakurun.sock`
|
|
188
|
+
* Config: `/usr/local/etc/mirakurun/`
|
|
189
|
+
* `server.yml`
|
|
190
|
+
* `tuners.yml`
|
|
191
|
+
* `channels.yml`
|
|
192
|
+
* Data: `/usr/local/var/db/mirakurun/`
|
|
193
|
+
* `services.json`
|
|
194
|
+
* `programs.json`
|
|
195
|
+
* Log: `/usr/local/var/log/`
|
|
196
|
+
* `mirakurun.stdout.log` - normal log
|
|
197
|
+
* `mirakurun.stderr.log` - error log
|
package/docker/README.md
CHANGED
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
```sh
|
|
4
4
|
# build
|
|
5
|
-
docker
|
|
5
|
+
docker compose -f docker/docker-compose.yml build
|
|
6
6
|
# run
|
|
7
|
-
docker
|
|
7
|
+
docker compose -f docker/docker-compose.yml run --rm --service-ports mirakurun
|
|
8
8
|
# run w/ env
|
|
9
|
-
docker
|
|
9
|
+
docker compose -f docker/docker-compose.yml run --rm --service-ports -e LOG_LEVEL=3 mirakurun
|
|
10
|
+
# setup
|
|
11
|
+
docker compose -f docker/docker-compose.yml run --rm --service-ports -e SETUP=true mirakurun
|
|
10
12
|
```
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "mirakurun",
|
|
3
3
|
"preferGlobal": true,
|
|
4
4
|
"description": "DVR Tuner Server for Japanese TV.",
|
|
5
|
-
"version": "4.0.0-beta.
|
|
5
|
+
"version": "4.0.0-beta.2",
|
|
6
6
|
"homepage": "https://github.com/Chinachu/Mirakurun",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"mirakurun",
|
|
@@ -31,7 +31,6 @@
|
|
|
31
31
|
},
|
|
32
32
|
"license": "Apache-2.0",
|
|
33
33
|
"bin": {
|
|
34
|
-
"mirakurun": "bin/cli.sh",
|
|
35
34
|
"mirakurun-epgdump": "bin/epgdump.js"
|
|
36
35
|
},
|
|
37
36
|
"main": "lib/client.js",
|