Skip to content

Latest commit

 

History

History
127 lines (94 loc) · 2.92 KB

Platforms.md

File metadata and controls

127 lines (94 loc) · 2.92 KB

Remarks for Platform Support

Overview

Bold is the recommended. also, Node.js ^8.9.4 < 9 || ^10.11.0 < 11 || ^12.13.0 < 13 needed.

  • Linux
    • PM2 >=2.4.0
    • x86 / x64 / ARMv7 / ARMv8
    • Debian / Ubuntu / CentOS / Gentoo
    • SystemV / OpenRC / SystemD
  • Win32 (Experimental)
  • Darwin (Experimental)

Linux

Installing Node.js

  • via Package Manager (recommended)
    • Debian / Ubuntu (deb)
      • curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
      • sudo apt-get install -y nodejs
    • CentOS (rpm)
      • (root) curl -sL https://rpm.nodesource.com/setup_12.x | bash -
    • Gentoo
      • emerge nodejs
  • nave
    • sudo /path/to/nave.sh usemain 12.13.0

Installing PM2

sudo npm install pm2 -g

Installing / Updating Mirakurun

# Quick
sudo npm install mirakurun -g --unsafe-perm --production

# Advanced
sudo npm install mirakurun -g --production
sudo mirakurun init # to install as service
sudo mirakurun restart # when updated

Uninstalling Mirakurun

# Quick
sudo npm uninstall mirakurun -g --unsafe-perm

# Advanced
sudo pm2 stop mirakurun-server
sudo pm2 delete mirakurun-server
sudo pm2 save
sudo npm uninstall mirakurun -g

Default Paths

  • /usr/local/etc/mirakurun/ - configurations
    • server.yml
    • tuners.yml
    • channels.yml
  • /usr/local/var/db/mirakurun/ - databases
    • services.json
    • programs.json
  • /usr/local/var/log/mirakurun.stdout.log - normal log
  • /usr/local/var/log/mirakurun.stderr.log - error log

Win32

Installing Node.js

Installing winser

use Windows PowerShell as Admin.

npm install [email protected] -g

Installing / Updating Mirakurun

use Windows PowerShell as Admin.

npm install mirakurun@latest -g --production

Uninstalling Mirakurun

use Windows PowerShell as Admin.

npm uninstall mirakurun -g

Managing Service

# start
Start-Service mirakurun
# stop
Stop-Service mirakurun

also you can use Service Manager of Task Manager.

Default Paths

  • ${USERPROFILE}/.Mirakurun/ - configurations
    • server.yml
    • tuners.yml
    • channels.yml
  • ${LOCALAPPDATA}/Mirakurun/ - databases
    • services.json
    • programs.json
  • ${LOCALAPPDATA}/Mirakurun/stdout - normal log
  • ${LOCALAPPDATA}/Mirakurun/stderr - error log