neko

package module

v1.6.18 Latest Latest Go to latest Published: Jan 26, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/demodesk/neko

Links

Open Source Insights

README ¶

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.
- Bandwidth estimation and adaptive quality.
Custom screen size (with automatic sync).
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).
Drag and drop passthrough.
File upload passthrough (experimental).
Microphone passthrough.
Webcam passthrough (experimental).
Bi-directional text/html clipboard.
Keyboard layouts/variants.
Metrics and REST API.

Docs

TBD.

Documentation ¶

Constants ¶

View Source

const Header = `` /* 191-byte string literal not displayed */

Variables ¶

View Source

var Version = &version{
	GitCommit: gitCommit,
	GitBranch: gitBranch,
	GitTag:    gitTag,
	BuildDate: buildDate,
	GoVersion: runtime.Version(),
	Compiler:  runtime.Compiler,
	Platform:  fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
}

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

neko.go

Directories ¶

Path	Synopsis
cmd
neko
internal
api
api/members
api/room
capture
config
desktop
http
member
member/file
member/multiuser
member/noauth
member/object
plugins
session
webrtc
webrtc/cursor
webrtc/payload
webrtc/pionlog
websocket
websocket/handler
pkg
auth
drop
gst
types
types/codec
types/event
types/message
utils From https://github.com/livekit/livekit/blob/master/pkg/sfu/streamallocator/trenddetector.go	From https://github.com/livekit/livekit/blob/master/pkg/sfu/streamallocator/trenddetector.go
xevent
xinput custom xf86 input driver communication protocol	custom xf86 input driver communication protocol
xorg

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL