# neko

**Repository Path**: suge168/neko

## Basic Information

- **Project Name**: neko
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-01
- **Last Updated**: 2025-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <a href="https://github.com/m1k1o/neko" title="Neko's Github repository.">
    <img src="https://neko.m1k1o.net/img/logo.png" width="400" height="auto"/>
  </a>
  <p align="center">
    <a href="https://github.com/m1k1o/neko/releases">
      <img src="https://img.shields.io/github/v/release/m1k1o/neko" alt="release">
    </a>
    <a href="https://github.com/m1k1o/neko/blob/master/LICENSE">
      <img src="https://img.shields.io/github/license/m1k1o/neko" alt="license">
    </a>
    <a href="https://hub.docker.com/u/m1k1o/neko">
      <img src="https://img.shields.io/docker/pulls/m1k1o/neko" alt="pulls">
    </a>
    <a href="https://github.com/m1k1o/neko/issues">
      <img src="https://img.shields.io/github/issues/m1k1o/neko" alt="issues">
    </a>
    <a href="https://github.com/sponsors/m1k1o">
      <img src="https://img.shields.io/badge/-sponsor-red" alt="issues">
    </a>
    <a href="https://discord.gg/3U6hWpC">
      <img src="https://discordapp.com/api/guilds/665851821906067466/widget.png" alt="Chat on discord">
    </a>
    <a href="https://hellogithub.com/repository/4536d4546af24196af3f08a023dfa007" target="_blank">
      <img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=4536d4546af24196af3f08a023dfa007&claim_uid=0x19e4dJwD83aW2&theme=small" alt="Featured｜HelloGitHub" />
    </a>
    <a href="https://github.com/m1k1o/neko/actions">
      <img src="https://github.com/m1k1o/neko/actions/workflows/ghcr.yml/badge.svg" alt="build">
    </a>
  </p>
  <img src="https://neko.m1k1o.net/img/intro.gif" width="650" height="auto"/>
</div>

# n.eko

欢迎使用Neko——这款基于Docker的自托管虚拟浏览器采用WebRTC技术，能为您在虚拟环境中提供功能完备的浏览器体验。通过Neko，您可像使用常规浏览器般安全私密地访问网络、运行应用程序及执行各类操作，所有这一切都在受保护的隔离环境中完成。无论您是需测试网页应用的开发者、注重隐私的安全浏览需求者，还是单纯想体验虚拟浏览器的便捷灵活，Neko都是理想之选。

除安全隐私特性外，Neko还支持多用户实时协同访问。团队需要共享浏览器时，或用户想通过多设备进入同一虚拟环境时，它都能完美胜任。您可轻松安全地与他人共享浏览器访问权限，无需维护复杂配置。无论是协同完成项目、调用共享资源，还是单纯想与亲友共享浏览器，Neko都能简单实现。

Neko更是举办观影会与互动演示的利器。其虚拟浏览器特性让您能组织全球可参与的线上活动，打破地理限制。即便无法线下相聚，也能随时与好友同事保持联动。通过Neko举办休闲观影会或工作演示会时，只需邀请参与者加入虚拟环境，即可实时共享屏幕并开展互动交流。

## About

这个应用程序使用WebRTC在docker容器中流式传输桌面，原作者之所以这样做是因为[rabb.it]（https://en.wikipedia.org/wiki/Rabb.it）崩溃了，他的互联网无法处理流式传输，当他的朋友尝试时，不和谐一直崩溃。他只是想和他的朋友一起看动画ლ(ಠ益ಠლ)所以他开始在互联网上挖掘，发现了一些*有点*克隆，但没有一个有虚拟浏览器，然后他找到了[Turtus]（https://github.com/Khauri/Turtus），他能够找出其余的。


然后我找到了[this]（https://github.com/nurdism/neko）项目并开始深入研究。我真的很喜欢多人协作浏览的想法，所以我创建了一个分支。最初，我想将我的更改合并到上游存储库中，但原作者没有时间再做这个项目了，它最终被存档了。


## Use-cases and comparison

Neko最初是一个使用WebRTC流式传输给多个用户的虚拟浏览器。
-它**不仅限于浏览器**；它可以运行任何在linux上运行的东西（例如VLC）。浏览器恰好是最流行和使用最广泛的用例。
-事实上，它也不仅限于单个程序；您可以安装完整的桌面环境（例如XFCE、KDE）。
-说到限制，它不需要在容器中运行；您可以在主机上安装neko，连接到X服务器并控制整个VM。
-理论上它不仅限于X服务器，任何可以定期控制和抓取图像的东西都可以使用。
-就像实现RDP或VNC协议一样，neko只会充当WebRTC中继服务器。这目前只是未来。


主要用例是与多人联系，利用实时同步和交互性：
-**观看派对**-与多人一起观看视频内容并对其做出反应（聊天、表情符号）-[giggl.app]（https://giggl.app/）或[超光束]（https://watch.hyperbeam.com）的开源替代方案。
-**交互式演示**-不仅屏幕共享，其他人也可以控制屏幕。
-**协作工具**-集思广益、共同浏览、代码调试。
-**支持/教学**-在受控环境中交互式指导人们。
-**嵌入任何东西**-在您的Web应用程序中嵌入虚拟浏览器-[超光束API]（https://hyperbeam.com/）的开源替代方案。
-打开任何第三方网站或应用程序，在多个参与者之间完美同步音频和视频。
-使用API与[neko房间]（https://github.com/m1k1o/neko-rooms）请求房间。


其他受益于单用户的用例：
-**个人工作空间**-将容器化应用程序和桌面流式传输给最终用户-类似于[kump]（https://www.kasmweb.com/）。
-**持久性浏览器**-拥有随时随地可用的持久性cookie的浏览器-类似于[😍tyapp]（https://www.mightyapp.com/）。
-终止连接后主机浏览器上不会留下任何状态。
-不会传输cookie等敏感数据-仅共享视频。
-**一次性浏览器**-计划秘密聚会和从互联网上购买生日礼物的更好解决方案。
-使用Tor浏览器和[VPN]（https://github.com/m1k1o/neko-vpn）以获得额外的匿名性。
-通过在容器中运行来降低操作系统指纹和浏览器漏洞的风险。
-**会话广播**-使用RTMP的广播室内容（例如twitch或youtube…）。
-**会话记录**-广播RTMP可以保存到文件中，例如[nginx-rtmp]（https://www.nginx.com/products/nginx/modules/rtmp-media-streaming/）
-录制教程时环境干净。
-无需隐藏书签或使用隐身模式。
-**跳转主机**-无需VPN即可安全地访问您的内部应用程序。
-**自动浏览器**-您可以安装[playwright]（https://playwright.dev/）或[木偶师]（https://pptr.dev/）并自动执行任务，同时能够主动拦截它们。


与无客户端远程桌面网关（例如[Apache Guacamole]（https://guacamole.apache.org/）或[websocket kify]（https://github.com/novnc/websockify）与[noVNC]（https://novnc.com/））相比，与远程桌面服务器一起安装所需的程序（例如[linuxserver/firefox]（https://docs.linuxserver.io/images/docker-firefox））还提供了neko：
-**流畅的视频**因为它使用WebRTC而不是通过WebSockets发送的图像。
-**内置音频**支持，不是Apache Guacamole或noVNC的一部分。
-**多参与者控制**，Apache Guacamole或noVNC原生不支持的内容。


### Supported browsers

<div align="center">
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#firefox">
    <img src="https://neko.m1k1o.net/img/icons/firefox.svg" title="ghcr.io/m1k1o/neko/firefox" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#tor-browser">
    <img src="https://neko.m1k1o.net/img/icons/tor-browser.svg" title="ghcr.io/m1k1o/neko/tor-browser" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#waterfox">
    <img src="https://neko.m1k1o.net/img/icons/waterfox.svg" title="ghcr.io/m1k1o/neko/waterfox" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#chromium">
    <img src="https://neko.m1k1o.net/img/icons/chromium.svg" title="ghcr.io/m1k1o/neko/chromium" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#google-chrome">
    <img src="https://neko.m1k1o.net/img/icons/google-chrome.svg" title="ghcr.io/m1k1o/neko/google-chrome" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#ungoogled-chromium">
    <img src="https://neko.m1k1o.net/img/icons/ungoogled-chromium.svg" title="ghcr.io/m1k1o/neko/google-chrome" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#microsoft-edge">
    <img src="https://neko.m1k1o.net/img/icons/microsoft-edge.svg" title="ghcr.io/m1k1o/neko/microsoft-edge" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#brave">
    <img src="https://neko.m1k1o.net/img/icons/brave.svg" title="ghcr.io/m1k1o/neko/brave" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#vivaldi">
    <img src="https://neko.m1k1o.net/img/icons/vivaldi.svg" title="ghcr.io/m1k1o/neko/vivaldi" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#opera">
    <img src="https://neko.m1k1o.net/img/icons/opera.svg" title="ghcr.io/m1k1o/neko/opera" width="60" height="auto"/>
  </a>

  ... see [all available images](https://neko.m1k1o.net/docs/v3/installation/docker-images)
</div>

### Other applications

<div align="center">
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#xfce">
    <img src="https://neko.m1k1o.net/img/icons/xfce.svg" title="ghcr.io/m1k1o/neko/xfce" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#kde">
    <img src="https://neko.m1k1o.net/img/icons/kde.svg" title="ghcr.io/m1k1o/neko/kde" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#remmina">
    <img src="https://neko.m1k1o.net/img/icons/remmina.svg" title="ghcr.io/m1k1o/neko/remmina" width="60" height="auto"/>
  </a>
  <a href="https://neko.m1k1o.net/docs/v3/installation/docker-images#vlc">
    <img src="https://neko.m1k1o.net/img/icons/vlc.svg" title="ghcr.io/m1k1o/neko/vlc" width="60" height="auto"/>
  </a>

  ... others in <a href="https://github.com/m1k1o/neko-apps">m1k1o/neko-apps</a>
</div>

### 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](https://github.com/m1k1o/neko-rooms).

It also offers [Zero-knowledge installation (with HTTPS)](https://github.com/m1k1o/neko-rooms/?tab=readme-ov-file#zero-knowledge-installation-with-https).

## Documentation

Full documentation is available at [neko.m1k1o.net](https://neko.m1k1o.net/). Key sections include:

- [Migration from V2](https://neko.m1k1o.net/docs/v3/migration-from-v2)
- [Getting Started](https://neko.m1k1o.net/docs/v3/quick-start)
- [Installation](https://neko.m1k1o.net/docs/v3/installation)
- [Examples](https://neko.m1k1o.net/docs/v3/installation/examples)
- [Configuration](https://neko.m1k1o.net/docs/v3/configuration)
- [Frequently Asked Questions](https://neko.m1k1o.net/docs/v3/faq)
- [Troubleshooting](https://neko.m1k1o.net/docs/v3/troubleshooting)

## How to Contribute

Contributions are welcome! Check the [Contributing Guide](https://neko.m1k1o.net/contributing) for details.

## Support

If you find Neko useful, consider supporting the project via [GitHub Sponsors](https://github.com/sponsors/m1k1o).