first commit

Makefile

@@ -0,0 +1,16 @@
+
+
+include $(TOPDIR)/rules.mk
+
+
+LUCI_TITLE:=LuCI support for neko
+LUCI_PKGARCH:=all
+LUCI_DEPENDS:=+lsblk +docker +luci-lib-taskd
+
+define Package/luci-app-neko/conffiles
+/etc/config/neko
+endef
+
+include $(TOPDIR)/feeds/luci/luci.mk
+
+# call BuildPackage - OpenWrt buildroot signature

luasrc/controller/neko.lua

@@ -0,0 +1,15 @@
+
+module("luci.controller.neko", package.seeall)
+
+function index()
+	entry({"admin", "apps"}, firstchild(), _("Apps") , 45).dependent = false
+	if not nixio.fs.access("/etc/config/neko") then
+		return
+	end
+
+	local page = entry({"admin", "apps", "neko"}, cbi("neko"), _("neko"))
+	page.order = 10
+	page.dependent = true
+	page.acl_depends = { "luci-app-neko" }
+	entry({"admin","apps","neko","status"},call("act_status")).leaf=true
+end

luasrc/model/cbi/neko.lua

@@ -0,0 +1,47 @@
+--[[
+LuCI - Lua Configuration Interface
+]]--
+
+local taskd = require "luci.model.tasks"
+local neko_model = require "luci.model.neko"
+local m, s, o
+
+m = taskd.docker_map("neko", "neko", "/usr/libexec/apps/neko/neko.sh",
+	translate("neko"),
+	translate("Welcome to Neko, a self-hosted virtual browser that runs in Docker and uses WebRTC technology. Neko is a powerful tool that allows you to run a fully-functional browser in a virtual environment that you can share with friends meow. When self hosting behind Wireguard be sure to forward internal and external udp port range 52000-52005. ")
+		.. translate("Official website:") .. ' <a href=\"https://github.com/m1k1o/neko/\" target=\"_blank\">https://github.com/m1k1o/neko/</a>')
+
+s = m:section(SimpleSection, translate("Service Status"), translate("neko status:"))
+s:append(Template("neko/status"))
+
+s = m:section(TypedSection, "neko", translate("Setup"), translate("Check output window for admin password"))
+s.addremove=false
+s.anonymous=true
+
+o = s:option(Value, "port", translate("Port").."<b>*</b>")
+o.rmempty = false
+o.default = "8281"
+o.datatype = "port"
+
+o = s:option(Value, "image_name", translate("Image").."<b>*</b>")
+o.rmempty = false
+o.datatype = "string"
+o:value("m1k1o/neko:firefox", "m1k1o/neko:firefox")
+o.default = "m1k1o/neko:firefox"
+
+local blocks = neko_model.blocks()
+local home = neko_model.home()
+
+o = s:option(Value, "config_path", translate("Router IP or WireGuard IP if self hosting").."<b>*</b>")
+o.rmempty = false
+o.datatype = "string"
+o:value("192.168.70.1", "192.168.70.1")
+o.default = "192.168.70.1"
+
+local paths, default_path = neko_model.find_paths(blocks, home, "Configs")
+for _, val in pairs(paths) do
+  o:value(val, val)
+end
+o.default = default_path
+
+return m

luasrc/model/neko.lua

@@ -0,0 +1,55 @@
+local util  = require "luci.util"
+local jsonc = require "luci.jsonc"
+
+local neko = {}
+
+neko.blocks = function()
+  local f = io.popen("lsblk -s -f -b -o NAME,FSSIZE,MOUNTPOINT --json", "r")
+  local vals = {}
+  if f then
+    local ret = f:read("*all")
+    f:close()
+    local obj = jsonc.parse(ret)
+    for _, val in pairs(obj["blockdevices"]) do
+      local fsize = val["fssize"]
+      if fsize ~= nil and string.len(fsize) > 10 and val["mountpoint"] then
+        -- fsize > 1G
+        vals[#vals+1] = val["mountpoint"]
+      end
+    end
+  end
+  return vals
+end
+
+neko.home = function()
+  local uci = require "luci.model.uci".cursor()
+  local home_dirs = {}
+  home_dirs["main_dir"] = uci:get_first("quickstart", "main", "main_dir", "/root")
+  home_dirs["Configs"] = uci:get_first("quickstart", "main", "conf_dir", home_dirs["main_dir"].."/Configs")
+  home_dirs["Public"] = uci:get_first("quickstart", "main", "pub_dir", home_dirs["main_dir"].."/Public")
+  home_dirs["Downloads"] = uci:get_first("quickstart", "main", "dl_dir", home_dirs["Public"].."/Downloads")
+  home_dirs["Caches"] = uci:get_first("quickstart", "main", "tmp_dir", home_dirs["main_dir"].."/Caches")
+  return home_dirs
+end
+
+neko.find_paths = function(blocks, home_dirs, path_name)
+  local default_path = ''
+  local configs = {}
+
+  default_path = home_dirs[path_name] .. "/neko"
+  if #blocks == 0 then
+    table.insert(configs, default_path)
+  else
+    for _, val in pairs(blocks) do 
+      table.insert(configs, val .. "/" .. path_name .. "/neko")
+    end
+    local without_conf_dir = "/root/" .. path_name .. "/neko"
+    if default_path == without_conf_dir then
+      default_path = configs[1]
+    end
+  end
+
+  return configs, default_path
+end
+
+return neko

luasrc/view/neko/status.htm

@@ -0,0 +1,31 @@
+<%
+local util  = require "luci.util"
+local container_status = util.trim(util.exec("/usr/libexec/apps/neko/neko.sh status"))
+local container_install = (string.len(container_status) > 0)
+local container_running = container_status == "running"
+-%>
+<div class="cbi-value">
+    <label class="cbi-value-title"><%:Status%></label>
+    <div class="cbi-value-field">
+        <% if container_running then %>
+        <button class="cbi-button cbi-button-success" disabled="true"><%:neko is running%></button>
+        <% else %>
+        <button class="cbi-button cbi-button-negative" disabled="true"><%:neko is not running%></button>
+        <% end %>
+    </div>
+</div>
+<%
+if container_running then
+    local port=util.trim(util.exec("/usr/libexec/apps/neko/neko.sh port"))
+    if port == "" then
+        port="8281"
+    end
+-%>
+<div class="cbi-value cbi-value-last">
+    <label class="cbi-value-title">&nbsp;</label>
+    <div class="cbi-value-field">
+
+    <input type="button" class="btn cbi-button cbi-button-apply" name="start" value="<%:Open neko%>" onclick="window.open('http://'+location.hostname+':<%=port%>/', '_blank')">
+    </div>
+</div>
+<% end %>

root/etc/config/neko

@@ -0,0 +1,5 @@
+config neko
+	option 'port' '8281'
+	option 'config_path' '192.168.70.1'
+	option 'image_name' 'm1k1o/neko:firefox'
+

root/etc/uci-defaults/luci-app-neko

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+config_dir=`uci -q get neko.@neko[0].config_path`
+
+data_dir=`docker inspect --format '{{.Mounts}}' neko | grep -Eom1 '[^ ]+/_data /var/www/html local  true ' | cut -d' ' -f1`
+
+if [ -n "$data_dir" -a "$data_dir" != "$config_dir" ]; then
+    uci -q batch <<-EOF >/dev/null
+        set neko.@neko[0].config_path="$data_dir"
+        commit neko
+EOF
+fi
+
+exit 0

root/usr/libexec/apps/neko/neko.sh

@@ -0,0 +1,112 @@
+#!/bin/sh
+
+ACTION=${1}
+shift 1
+
+get_image() {
+  IMAGE_NAME="m1k1o/neko:firefox"
+}
+
+do_install_detail() {
+  local config=`uci get neko.@neko[0].config_path 2>/dev/null`
+  local port=`uci get neko.@neko[0].port 2>/dev/null`
+  local IMAGE_NAME=`uci get neko.@neko[0].image_name 2>/dev/null`
+  local username=`uci get neko.@neko[0].username 2>/dev/null`
+  local password=`uci get neko.@neko[0].password 2>/dev/null`
+
+  #Generate the generic environment variables for the docker-compose
+
+  GEN_PASS=$(< /dev/urandom tr -dc A-Za-z0-9 2>/dev/null | head -c14; echo)
+  GEN_PASS2=$(< /dev/urandom tr -dc A-Za-z0-9 2>/dev/null | head -c14; echo)
+  
+  # Get our local LAN IP Address
+  LAN_IP=$(uci get network.lan.ipaddr)
+  # Strip trailing network mask
+  LAN_IP="${LAN_IP%/*}"
+   
+  if [ -z "$config" ]; then
+      echo "config path is empty!"
+      exit 1
+  fi
+
+  [ -z "$port" ] && port=8281
+  [ -z "$IMAGE_NAME" ] && IMAGE_NAME=m1k1o/neko:firefox
+
+  
+  # Create Docker Compose file with custom variables
+   
+  # Create Docker Compose file with custom variables
+touch docker-compose.yml
+cat > docker-compose.yml <<EOF
+version: "3.4"
+services:
+  neko:
+    image: $IMAGE_NAME
+    restart: "unless-stopped"
+    shm_size: "2gb"
+    ports:
+      - "$port:8080"
+      - "52000-52005:52000-52005/udp"
+    environment:
+      NEKO_SCREEN: '1920x1080@30'
+      NEKO_PASSWORD: meowmix
+      NEKO_PASSWORD_ADMIN: ${GEN_PASS}
+      NEKO_EPR: 52000-52005
+      NEKO_NAT1TO1: $config
+    labels:
+      plugsy.name: "neko"
+      plugsy.category: "Home"
+      plugsy.icon: "@styled-icons/entypo/Cat"
+      plugsy.link: "http://$config:$port"
+EOF
+  
+  docker-compose up -d
+ 
+  # Add a new list option to the "shortcutmenu" configuration file
+  uci add shortcutmenu lists
+  uci set shortcutmenu.@lists[-1].webname="$IMAGE_NAME"
+  uci set shortcutmenu.@lists[-1].weburl="$config:$port"
+  uci set shortcutmenu.@lists[-1].webpath="/"
+  uci commit shortcutmenu
+
+  echo "Your Neko admin password is: " $GEN_PASS
+  echo "The default password for viewers is: meowmix"
+
+}
+
+usage() {
+  echo "usage: $0 sub-command"
+  echo "where sub-command is one of:"
+  echo "      install                Install neko"
+  echo "      upgrade                Upgrade neko"
+  echo "      rm/start/stop/restart  Remove/Start/Stop/Restart neko"
+  echo "      status                 neko status"
+  echo "      port                   neko port"
+}
+
+case ${ACTION} in
+  "install")
+    get_image
+    do_install_detail
+  ;;
+  "upgrade")
+    get_image
+    do_install_detail
+  ;;
+  "rm")
+    docker rm -f neko
+  ;;
+  "start" | "stop" | "restart")
+    docker ${ACTION} neko
+  ;;
+  "status")
+    docker ps --all -f 'name=neko' --format '{{.State}}'
+  ;;
+  "port")
+    docker ps --all -f 'name=neko' --format '{{.Ports}}' | grep -om1 '0.0.0.0:[0-9]*' | sed 's/0.0.0.0://'
+  ;;
+  *)
+    usage
+    exit 1
+  ;;
+esac

root/usr/share/rpcd/acl.d/luci-app-neko.json

@@ -0,0 +1,11 @@
+{
+	"luci-app-neko": {
+		"description": "Grant UCI access for luci-app-neko",
+		"read": {
+			"uci": [ "neko" ]
+		},
+		"write": {
+			"uci": [ "neko" ]
+		}
+	}
+}