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)

remote-control
Searching Database…

22.5K ·GitHub
What is this?Neko is a self-hosted virtual browser that runs in Docker and streams its screen to viewers over WebRTC, so several people can browse and interact together in real time.
Is it locked to a browser, or can it run other things?It can run anything that runs on Linux, such as VLC, or a full desktop environment like XFCE or KDE. It can also skip the container entirely and connect to your host's X server.
How do I set it up for me and my friends?Run the Neko Docker image on your own server and share the room's web link. The separate neko-rooms companion manages multiple rooms and offers a zero-knowledge installation with HTTPS.
What do I need to host it, and what do my guests need to join?You need a server with Docker to host it. Guests only need a device with a WebRTC-capable browser, since the session is streamed as video to a web page — nothing to install on their side.
What happens to my cookies and login data?No state is left on your host browser after the session ends, and sensitive data like cookies never leaves the server — only the video stream is shared. Tor Browser or a VPN can be run inside for extra anonymity.
Why did the author build this?The original author made it after rabb.it shut down, because his internet could not handle streaming and Discord kept crashing — he just wanted to watch anime with friends. m1k1o forked it because he liked collaborative browsing, and the upstream project was later archived.
Can I broadcast or record a session?Yes. Room content can be broadcast over RTMP to services like Twitch or YouTube, and that RTMP stream can be saved to a file with something like nginx-rtmp — handy for recording tutorials in a clean environment without hiding bookmarks.
Can I embed the virtual browser in my own web app?Yes, embedding is an advertised use case — an open source alternative to the hyperbeam API. Rooms can also be requested via an API through neko-rooms, and people have even run Neko inside VR Chat to watch the web together.
Is it only useful for groups, or does it make sense to run it solo?Solo too: a persistent browser with your cookies available anywhere, a throwaway browser for planning secret gifts, a jump host to reach internal apps without a VPN, and automated browsing with Playwright or Puppeteer that you can intercept live.
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