neko README

The project's README from github.com/m1k1o/neko. As one markdown file: README.md.

release license pulls issues issues Chat on discord Featured|HelloGitHub build

n.eko

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, giving you the ability to access the internet securely and privately from anywhere. With Neko, you can browse the web, run applications, and perform other tasks just as you would on a regular browser, all within a secure and isolated environment. Whether you are a developer looking to test web applications, a privacy-conscious user seeking a secure browsing experience, or simply someone who wants to take advantage of the convenience and flexibility of a virtual browser, Neko is the perfect solution.

In addition to its security and privacy features, Neko offers the ability for multiple users to access it simultaneously. This makes it an ideal solution for teams or organizations that need to share access to a browser, as well as for individuals who want to use multiple devices to access the same virtual environment. With Neko, you can easily and securely share access to a browser with others, without having to worry about maintaining separate configurations or settings. Whether you need to collaborate on a project, access shared resources, or simply want to share access to a browser with friends or family, Neko makes it easy to do so.

Neko is also a great tool for hosting watch parties and interactive presentations. With its virtual browser capabilities, Neko allows you to host watch parties and presentations that are accessible from anywhere, without the need for in-person gatherings. This makes it easy to stay connected with friends and colleagues, even when you are unable to meet in person. With Neko, you can easily host a watch party or give an interactive presentation, whether it's for leisure or work. Simply invite your guests to join the virtual environment, and you can share the screen and interact with them in real-time.

About

This app uses WebRTC to stream a desktop inside of a docker container, original author made this because rabb.it went under and his internet could not handle streaming and discord kept crashing when his friend attempted to. He just wanted to watch anime with his friends ლ(ಠ益ಠლ) so he started digging throughout the internet and found a few kinda clones, but none of them had the virtual browser, then he found Turtus and he was able to figure out the rest.

Then I found this project and started to dig into it. I really liked the idea of having collaborative browser browsing together with multiple people, so I created a fork. Initially, I wanted to merge my changes to the upstream repository, but the original author did not have time for this project anymore and it got eventually archived.

Use-cases and comparison

Neko started as a virtual browser that is streamed using WebRTC to multiple users.

Primary use case is connecting with multiple people, leveraging real time synchronization and interactivity:

Other use cases that benefit from single-user:

Compared to clientless remote desktop gateway (e.g. Apache Guacamole or websockify with noVNC), installed with remote desktop server along with desired program (e.g. linuxserver/firefox) provides neko additionally:

Supported browsers

... see all available images

Other applications

... others in m1k1o/neko-apps

Why neko?

I like cats 🐱 (Neko is the Japanese word for cat), I'm a weeb/nerd.

But why the cat butt? Because cats are assholes, but you love them anyways.

Multiple rooms

For neko room management software, visit neko-rooms.

It also offers Zero-knowledge installation (with HTTPS).

Documentation

Full documentation is available at neko.m1k1o.net. Key sections include:

How to Contribute

Contributions are welcome! Check the Contributing Guide for details.

Support

If you find Neko useful, consider supporting the project via GitHub Sponsors.

neko (m1k1o/neko)

Searching Database…

22.5K ·GitHub
这是什么?Neko 是一个可以自己搭建的虚拟浏览器,运行在 Docker 里,通过 WebRTC 把屏幕画面实时串流给观看者,这样几个人就能一起实时浏览网页、互相操作。
它只能在浏览器里跑,还是能运行别的东西?凡是 Linux 上能跑的它都能跑,比如 VLC,或者 XFCE、KDE 这样的完整桌面环境。它甚至可以完全不用容器,直接连接你宿主机的 X server。
我怎么给自己和朋友搭建一个?在你自己的服务器上运行 Neko 的 Docker 镜像,然后把房间的网页链接分享出去即可。另外还有一个独立的配套工具 neko-rooms,可以管理多个房间,并提供带 HTTPS 的零配置安装。
我搭建它需要什么,来join的朋友又需要什么?搭建需要一台装了 Docker 的服务器。来join的朋友只需要一台设备上有支持 WebRTC 的浏览器就行,因为会话是以视频形式串流到网页上的——他们那边什么都不用装。
我的 Cookie 和登录数据会怎么样?会话结束后,不会在你的本地浏览器留下任何状态,Cookie 这类敏感数据也永远不会离开服务器——共享出去的只有视频画面。还可以在里面运行 Tor Browser 或 VPN,获得更强的匿名性。
作者为什么要做这个项目?原作者是在 rabb.it 关闭之后做的这个项目,因为他的网速撑不起串流,Discord 又总是崩溃——他只是想和朋友们一起看动漫而已。m1k1o 因为喜欢一起浏览网页的玩法所以 fork 了这个项目,而上游项目后来已被归档。
我能直播或录制会话吗?可以。房间内容可以通过 RTMP 推流到 Twitch 或 YouTube 这类平台,而且这个 RTMP 流还能用 nginx-rtmp 之类的工具保存成文件——在干净的环境里录制教程而不用藏起书签栏,非常方便。
我能把这个虚拟浏览器嵌入自己的网页应用里吗?可以,嵌入就是官方宣传的用途之一——相当于 hyperbeam API 的开源替代品。房间还可以通过 neko-rooms 用 API 来创建,甚至有人在 VR Chat 里运行 Neko 一起看网页。
它只适合一群人用吗,还是一个人用也有意义?一个人用也很有价值:比如一个带着你 Cookie 的常驻浏览器,随时随地都能用;一个用来偷偷策划惊喜礼物的临时浏览器;一个不用 VPN 就能访问内网应用的跳板机;还有可以实时旁观拦截的 Playwright 或 Puppeteer 自动化浏览。
What are similar projects?go2rtc, livego, livekit, server, chat, WebRTC-Experiment, Apollo, srs
Creator
m1k1o
Size
90 MB
Stars
22.5K
Age
6y
Commits · 90 Days