neko mirror
Go to file
2023-04-24 22:19:48 +02:00
.devcontainer Upgrade to go 1.20 (#30) 2023-02-26 21:57:02 +01:00
.github/workflows Add GitHub Actions (#2) 2022-07-15 00:29:57 +02:00
.vscode vscode debugging. 2022-02-09 23:10:29 +01:00
cmd Add plugins required flag (#40) 2023-03-31 12:02:33 +02:00
dev Build gstreamer in nvidia image (#36) 2023-04-04 23:52:15 +02:00
internal Refactor websocket session sync (#44) 2023-04-23 11:23:20 +02:00
pkg use DefaultRootWindow. 2023-04-24 22:19:48 +02:00
plugins add plugins folder. 2022-07-14 22:10:41 +02:00
runtime pulseaudio log level error. 2023-03-31 19:07:38 +02:00
.editorconfig clean up repository. 2021-02-21 00:40:52 +01:00
.gitattributes add gitattributes. 2020-11-27 22:25:27 +01:00
.gitignore add plugins folder. 2022-07-14 22:10:41 +02:00
build fix build pipe redirection. 2022-10-24 22:54:28 +02:00
Dockerfile configure pulseaudio from env. (#39) 2023-03-27 18:34:05 +02:00
Dockerfile.nvidia Build gstreamer in nvidia image (#36) 2023-04-04 23:52:15 +02:00
go.mod upgrade go dependencies. (#41) 2023-03-31 19:35:09 +02:00
go.sum upgrade go dependencies. (#41) 2023-03-31 19:35:09 +02:00
LICENSE add LICENSE. 2022-07-18 22:08:47 +02:00
neko.go set version from git tag. 2022-07-04 19:14:52 +02:00
openapi.yaml Add batch endpoint (#19) 2023-01-09 23:18:47 +01:00
README.md add README. 2022-08-01 00:26:53 +02:00

neko

This app uses WebRTC to stream a desktop inside of a docker container. Client can be found here: demodesk/neko-client.

For community edition neko with GUI and plug & play deployment visit m1k1o/neko.

m1k1o/neko vs demodesk/neko, why do we have two of them?

This project started as a fork of m1k1o/neko. But over time, development went way ahead of the original one in terms of features, updates and refactoring. The goal is to rebase m1k1o/neko repository onto this one and move all extra features (such as chat and emotes) to a standalone plugin.

  • This project is aimed to be the engine providing foundation for all applications that are streaming desktop environment using WebRTC to the browser.
  • m1k1o/neko is meant to be self-hosted replacement for rabb.it: Community edition with well-known GUI, all the social functions (such as chat and emotes) and easy deployment.

Notable differences to the m1k1o/neko are:

  • Go plugin support.
  • Multiple encoding qualities simulcast.
  • Single cursor for host - cursor image proxying.
  • Custom cursor style/badge for participants.
  • Inactive cursors (participants that are not hosting).
  • Fallback mode and reconnection improvements:
    • Watching using screencasting.
    • Controlling using websockets.
  • Members handling:
    • Access control (view, interactivity, clipboard).
    • Posibility to add external members providers.
    • Persistent login (using cookies).
    • Split members and sessions.
  • Drag and drop passthrough.
  • File upload passthrough (experimental).
  • Microphone passthrough.
  • Webcam passthrough (experimental).
  • Bi-directional text/html clipboard.
  • Keyboard layouts/variants.

Docs

TBD.