Home

Awesome

neko-rooms

<p align="center"> <img src="https://img.shields.io/github/v/release/m1k1o/neko-rooms" alt="release"> <img src="https://img.shields.io/github/license/m1k1o/neko-rooms" alt="license"> <img src="https://img.shields.io/docker/pulls/m1k1o/neko-rooms" alt="pulls"> <img src="https://img.shields.io/github/issues/m1k1o/neko-rooms" alt="issues"> <a href="https://discord.gg/3U6hWpC" ><img src="https://discordapp.com/api/guilds/665851821906067466/widget.png" alt="Chat on discord"></a> </p>

Simple room management system for n.eko. Self hosted rabb.it alternative.

<div align="center"> <img src="https://github.com/m1k1o/neko-rooms/raw/master/docs/rooms.png" alt="rooms"> <img src="https://github.com/m1k1o/neko-rooms/raw/master/docs/new_room.png" alt="new room"> <img src="https://github.com/m1k1o/neko-rooms/raw/master/docs/neko.gif" alt="n.eko"> </div>

Zero-knowledge installation (with HTTPS and Traefik)

If you don't have any clue about docker and stuff but only want to have fun with friends in a shared browser, we got you covered!

wget -O neko-rooms.sh https://raw.githubusercontent.com/m1k1o/neko-rooms/master/traefik/install
sudo bash neko-rooms.sh

How to start

If you want to use Traefik as reverse proxy, visit installation guide for traefik as reverse proxy.

Otherwise modify variables in docker-compose.yml and just run docker-compose up -d.

Download images / update

You need to pull all your images, that you want to use with neko-room. Otherwise, you might get this error: Error response from daemon: No such image: (see issue #1).

docker pull m1k1o/neko:firefox
docker pull m1k1o/neko:chromium
# etc...

If you want to update neko image, you need to pull new image and recreate all rooms, that use old image. To update neko rooms, simply run:

docker-compose pull
docker-compose up -d

Enable storage

You might have encountered this error:

Mounts cannot be specified because storage is disabled or unavailable.

If you didn't specify storage yet, you can do it using this tutorial.

Use nvidia GPU

If you want to use nvidia GPU, you need to install nvidia-docker.

Change neko images to nvidia images in docker-compose.yml using envorinment variable NEKO_ROOMS_NEKO_IMAGES:

NEKO_ROOMS_NEKO_IMAGES="
  ghcr.io/m1k1o/neko/nvidia-chromium:latest
  ghcr.io/m1k1o/neko/nvidia-google-chrome:latest
  ghcr.io/m1k1o/neko/nvidia-microsoft-edge:latest
  ghcr.io/m1k1o/neko/nvidia-brave:latest
"

When creating new room, you need to specify to use GPU in expext settings.

Docs

For more information visit docs.

Roadmap: