m1k1o/neko-rooms

neko-rooms

n.eko 的简易房间管理系统，自托管的 rabb.it 替代品。

镜像概述和主要用途

neko-rooms 是一个基于 Docker 的虚拟浏览器房间管理系统，旨在提供自托管的多人共享浏览解决方案。它允许用户创建和管理多个独立的虚拟浏览器房间，支持多人实时共享浏览内容，是替代 rabb.it 等在线服务的自建方案。

核心功能和特性

• 图形化管理界面：提供直观的 GUI 界面，方便创建、管理和监控房间
• HTTPS 支持：集成 Traefik 实现安全的 HTTPS 访问
• 用户认证：支持基于 Traefik 的用户认证机制
• 自定义环境变量：允许为每个房间配置自定义环境变量
• 数据持久化：支持目录挂载，实现房间数据的持久化存储
• Docker 集成：与 Docker 生态深度集成，支持容器化部署和管理

使用场景和适用范围

• 个人或小团队的共享浏览需求
• 远程协作中的网页内容共享
• 在线会议或教学中的实时演示
• 家庭或朋友间的共享娱乐活动
• 需要自托管控制数据隐私的场景

使用方法和配置说明

零知识安装（适合非技术用户）

如果您不了解 Docker 等技术，但希望与朋友共享浏览器体验，可按以下步骤操作：

1. 租用一台具有公网 IP 的 VPS，操作系统选择 Ubuntu
2. 获取一个指向您 IP 的域名（可使用免费域名）
3. 运行安装脚本并按照提示操作：

bash
curl https://raw.githubusercontent.com/m1k1o/neko-rooms/master/install | sudo bash

常规安装（需要 Docker 知识）

前置要求

• 已安装 Docker 和 docker-compose
• 已配置指向服务器 IP 的自定义域名

可参考 Dr R1ck 提供的安装视频：
[***]

安装指南

仅需准备 .env.example、docker-compose.yml 和 traefik/ 目录。

关于 Traefik 的说明

• 必须使用 Traefik 来转发房间流量，可在其前方放置 nginx，但不能替换 Traefik
• Traefik 配置的域名必须与代理连接的域名匹配（在 docker-compose 中为服务名称）
• 可参考 nginx 示例配置

如需仅暴露 HTTP 服务，可使用 docker-compose.http.yml，将服务暴露到 8080 端口或其他端口，认证为可选配置。

步骤 1：配置环境变量

复制 .env.example 到 .env 并自定义：

bash
cp .env.example .env

步骤 2：创建用户文件

创建 traefik/usersfile 文件：

bash
touch traefik/usersfile

添加用户（可添加多个）：

bash
echo $(htpasswd -nb 用户名 密码) >> traefik/usersfile

步骤 3：配置 HTTPS（仅 HTTPS 模式需要）

创建 acme.json 文件：

bash
touch traefik/acme.json
chmod 600 traefik/acme.json

在 traefik/traefik.yml 中更新您的***。

下载/更新镜像

需要拉取所有要用于 neko-rooms 的镜像，否则可能出现 Error response from daemon: No such image: 错误（参见 issue #1）：

sh
docker pull docker.xuanyuan.run/m1k1o/neko:latest
docker pull docker.xuanyuan.run/m1k1o/neko:chromium
# 可根据需要拉取其他镜像

如需更新 neko 镜像，需拉取新镜像并重新创建使用旧镜像的房间。更新 neko-rooms 本身：

sh
docker-compose pull
docker-compose up -d

路线图

• 添加 GUI
• 添加 HTTPS 支持
• 为 Traefik 添加认证提供器
• 允许指定自定义环境变量
• 允许挂载目录实现数据持久化
• 添加升级按钮
• 自动拉取不存在的镜像
• 为 API 添加 bearer token
• 添加 Docker SSH/TCP 支持
• 添加 Docker Swarm 支持
• 添加 Kubernetes 支持