mirakurun 4.0.0-beta.1 → 4.0.0-beta.3

package/README.md

@@ -22,7 +22,7 @@ see: available [Tags](https://hub.docker.com/r/chinachu/mirakurun/tags) (Docker
 ```sh
 mkdir ~/mirakurun/
 cd ~/mirakurun/
-wget https://raw.githubusercontent.com/Chinachu/Mirakurun/master/docker/docker-compose.yml
+wget https://raw.githubusercontent.com/Chinachu/Mirakurun/refs/heads/release/4.0.0/docker/docker-compose.yml
 docker compose pull
 docker compose run --rm -e SETUP=true mirakurun
 docker compose up -d

package/doc/Configuration.md

@@ -6,9 +6,9 @@
 
 ## server.yml
 
-```sh
-sudo mirakurun config server
-```
+* Env: `SERVER_CONFIG_PATH`
+* Docker Host (default): `/opt/mirakurun/config/server.yml`
+* Linux (legacy): `/usr/local/etc/mirakurun/server.yml`
 
 ### Structure
 
@@ -31,7 +31,7 @@ allowIPv4CidrRanges: ["10.0.0.0/8", "127.0.0.0/8", "172.16.0.0/12", "192.168.0.0
 allowIPv6CidrRanges: ["fc00::/7"] # array of string
 ```
 
-### Environment Values (Docker)
+### Environment Variables (Docker)
 
 ```sh
 HOSTNAME
@@ -51,9 +51,9 @@ ALLOW_IPV6_CIDR_RANGES
 
 ## tuners.yml
 
-```sh
-sudo mirakurun config tuners
-```
+* Env: `TUNERS_CONFIG_PATH`
+* Docker Host (default): `/opt/mirakurun/config/tuners.yml`
+* Linux (legacy): `/usr/local/etc/mirakurun/tuners.yml`
 
 ### Structure
 
@@ -97,9 +97,9 @@ sudo npm install arib-b25-stream-test -g --unsafe-perm
 
 ## channels.yml
 
-```sh
-sudo mirakurun config channels
-```
+* Env: `CHANNELS_CONFIG_PATH`
+* Docker Host (default): `/opt/mirakurun/config/channels.yml`
+* Linux (legacy): `/usr/local/etc/mirakurun/channels.yml`
 
 ### Structure
 

package/doc/Platforms.md

@@ -2,15 +2,20 @@
 
 ## Overview
 
-**Bold** is the recommended. also, **Node.js** `^18 || ^20 || ^22` needed.
+**Bold** is the recommended.
 
 * [**Docker on Linux**](#docker-on-linux)
   * [Docker Engine](https://docs.docker.com/engine/install/) `>=18.06.0`
   * [Docker Compose](https://docs.docker.com/compose/install/) `>=1.22.0`
   * **x64** / arm32v7 / **arm64v8**
-  * **Ubuntu Server 20.04** / Debian 9 / CentOS 8.1
+  * **Ubuntu Server 24.10** / etc.
   * ⚠ Note: Desktop Environment / VM is not supported and unstable!
 
+* [Linux w/ PM2 (legacy)](#linux-w-pm2-legacy)
+  * git
+  * [Node.js](https://nodejs.org/en/download) `^18 || ^20 || ^22`
+  * [PM2](https://pm2.keymetrics.io/)
+
 ## Docker on Linux
 
 **Note:**
@@ -20,7 +25,7 @@
 * PT2/PT3/PX-* users: Use default DVB driver instead of chardev driver.
   * please uninstall chardev drivers then reboot before install.
 
-### Docker
+### Install Docker Engine
 
 ```sh
 # for new machine
@@ -37,7 +42,7 @@ sudo mkdir -p /opt/mirakurun/run /opt/mirakurun/opt /opt/mirakurun/config /opt/m
 # Install
 mkdir ~/mirakurun/
 cd ~/mirakurun/
-wget https://raw.githubusercontent.com/Chinachu/Mirakurun/master/docker/docker-compose.yml
+wget https://raw.githubusercontent.com/Chinachu/Mirakurun/refs/heads/release/4.0.0/docker/docker-compose.yml
 docker compose pull
 docker compose run --rm -e SETUP=true mirakurun
 docker compose up -d
@@ -148,3 +153,46 @@ $ cp /usr/local/bin/something-static /opt/mirakurun/opt/bin/
 * Opt: `/opt/mirakurun/opt/`
   * `bin/`
   * `bin/startup` - custom startup script (optional)
+
+## Linux w/ PM2 (legacy)
+
+This is not recommended.
+The code related to PM2 has already been removed and is not confirmed to work.
+
+```sh
+git clone git@github.com:Chinachu/Mirakurun.git
+cd Mirakurun
+git submodule update --init --recursive
+
+npm install
+npm run build
+
+npm install pm2 -g
+pm2 startup
+
+# start
+pm2 start processes.json
+pm2 save
+
+# stop
+pm2 stop processes.json
+pm2 save
+
+# uninstall
+pm2 delete processes.json
+pm2 save
+```
+
+### 💡 Locations
+
+* Socket: `/var/run/mirakurun.sock`
+* Config: `/usr/local/etc/mirakurun/`
+  * `server.yml`
+  * `tuners.yml`
+  * `channels.yml`
+* Data: `/usr/local/var/db/mirakurun/`
+  * `services.json`
+  * `programs.json`
+* Log: `/usr/local/var/log/`
+  * `mirakurun.stdout.log` - normal log
+  * `mirakurun.stderr.log` - error log

package/docker/README.md

@@ -2,9 +2,19 @@
 
 ```sh
 # build
-docker-compose -f docker/docker-compose.yml build
+npm run docker:build
+# setup
+npm run docker:run-setup
 # run
-docker-compose -f docker/docker-compose.yml run --rm --service-ports mirakurun
+npm run docker:run
 # run w/ env
-docker-compose -f docker/docker-compose.yml run --rm --service-ports -e LOG_LEVEL=3 mirakurun
+docker compose -f docker/docker-compose.yml run --rm --service-ports -e LOG_LEVEL=3 mirakurun
+# up
+npm run docker:up
+# down
+npm run docker:down
+# logs
+npm run docker:logs
+# bash
+npm run docker:bash
 ```

package/docker/container-init.sh

@@ -11,6 +11,10 @@ export PATH=/opt/bin:$PATH
 export DOCKER=YES
 export INIT_PID=$$
 
+# npm
+export npm_config_cache=/tmp/.npm
+export npm_config_update_notifier=false
+
 # tweaks for glibc memory usage
 export MALLOC_ARENA_MAX=2
 

package/docker/docker-compose.yml

@@ -3,6 +3,9 @@ services:
     build:
       context: ../
       dockerfile: docker/Dockerfile
+    # `:latest` can be changed to fix the version
+    # `:latest` の部分を編集するとバージョンを固定できます
+    # available tags: https://hub.docker.com/r/chinachu/mirakurun/tags
     image: chinachu/mirakurun:latest
     container_name: mirakurun
     cap_add:
@@ -10,12 +13,19 @@ services:
       - SYS_NICE
     environment:
       TZ: Asia/Tokyo
+      # comment out below if you commented out `network_mode: host`
+      # `network_mode: host` をコメントアウトする場合はここもコメントアウト
       DOCKER_NETWORK: host
+      # you must set hostname if accesing by hostname (other than IP address)
+      # ブラウザから IP アドレス以外でアクセスする場合はホスト名を設定する必要があります
+      # hostname: localhost
+      # --
+      # for debug
       # LOG_LEVEL: "3"
       # DEBUG: "true"
     network_mode: host
     # comment out `devices:` if you commented out all devices
-    # device を全てコメントアウトした場合は devices: もコメントアウト
+    # `devices` を全てコメントアウトした場合は `devices:` もコメントアウト
     devices:
       # comment out below if you don't use card readers
       # カードリーダーを使わない場合は以下をコメントアウト
@@ -25,26 +35,12 @@ services:
       - /dev/dvb:/dev/dvb
     volumes:
       # you can change to any location if you want.
-      - type: bind
-        source: /opt/mirakurun/run
-        target: /var/run
-        bind:
-          create_host_path: true
-      - type: bind
-        source: /opt/mirakurun/opt
-        target: /opt
-        bind:
-          create_host_path: true
-      - type: bind
-        source: /opt/mirakurun/config
-        target: /app-config
-        bind:
-          create_host_path: true
-      - type: bind
-        source: /opt/mirakurun/data
-        target: /app-data
-        bind:
-          create_host_path: true
+      - /opt/mirakurun/run:/var/run
+      - /opt/mirakurun/opt:/opt
+      - /opt/mirakurun/config:/app-config
+      - /opt/mirakurun/data:/app-data
+    tmpfs:
+      - /tmp
     restart: always
     logging:
       driver: json-file

package/package.json

@@ -2,7 +2,7 @@
   "name": "mirakurun",
   "preferGlobal": true,
   "description": "DVR Tuner Server for Japanese TV.",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.3",
   "homepage": "https://github.com/Chinachu/Mirakurun",
   "keywords": [
     "mirakurun",
@@ -31,7 +31,6 @@
   },
   "license": "Apache-2.0",
   "bin": {
-    "mirakurun": "bin/cli.sh",
     "mirakurun-epgdump": "bin/epgdump.js"
   },
   "main": "lib/client.js",
@@ -52,7 +51,9 @@
     "docker:run-setup": "docker compose -f docker/docker-compose.yml run --rm -e SETUP=true --service-ports mirakurun",
     "docker:run": "docker compose -f docker/docker-compose.yml run --rm --service-ports mirakurun",
     "docker:up": "docker compose -f docker/docker-compose.yml up -d",
+    "docker:down": "docker compose -f docker/docker-compose.yml down",
     "docker:logs": "docker compose -f docker/docker-compose.yml logs -f",
+    "docker:bash": "docker compose -f docker/docker-compose.yml exec mirakurun bash",
     "docker:debug": "docker compose -f docker/docker-compose.yml run --rm --service-ports -e DEBUG=true mirakurun"
   },
   "directories": {