• Stars
    star
    366
  • Rank 112,879 (Top 3 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created about 3 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Selfhosted collaborative browser - room management for n.eko

neko-rooms

release license pulls issues Chat on discord

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

rooms new room n.eko

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!

  • Rent a VPS with public IP and OS Ubuntu.
  • Get a domain name pointing to your IP (you can even get some for free).
  • Run install script and follow instructions.
  • Secure using HTTPs thanks to Let's Encrypt and Traefik.
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:

  • add GUI
  • add HTTPS support
  • add authentication provider for traefik
  • allow specifying custom ENV variables
  • allow mounting directories for persistent data
  • optionally remove Traefik as dependency
  • add upgrade button
  • auto pull images, that do not exist
  • add bearer token to for API
  • add docker SSH / TCP support
  • add docker swarm support
  • add k8s support

More Repositories

1

neko

A self hosted virtual browser that runs in docker and uses WebRTC.
Go
5,061
star
2

blog

Lightweight self-hosted facebook-styled PHP blog.
PHP
301
star
3

go-transcode

On-demand transcoding origin server for live inputs and static files in Go using ffmpeg. Also with NVIDIA GPU hardware acceleration.
Go
190
star
4

neko-apps

Virtual environment in web browser.
Dockerfile
42
star
5

hls-restream

Restream live content as HLS using ffmpeg in docker. Also with NVIDIA GPU hardware acceleration.
Shell
32
star
6

win10-in-docker

Run WIN10 inside Docker, connect via VNC - lightweight repository.
Dockerfile
24
star
7

chat

Lightweight plug & play, self-hosted, zeroconfig node.js chat.
JavaScript
22
star
8

neko-vpn

Use virtual browser n.eko with VPN.
JavaScript
13
star
9

osx-in-docker

Run OSX inside Docker, connect via VNC - lightweight repository.
Dockerfile
11
star
10

email-auth

A simple passwordless authentication middleware using email.
Go
7
star
11

router

Router in C# for demonstrational purposes.
C#
6
star
12

ovpn-nodejs

Control OVPN (+ Proxy server) via HTTP.
JavaScript
6
star
13

vuejs-telnet-router

Vue.js telnet client for sending batch commands to (cisco) routers.
JavaScript
5
star
14

router-gui

Vue.JS GUI for C# Router. https://github.com/m1k1o/router
JavaScript
5
star
15

ext4-backup-pointers

EXT4 backup inode data pointers & recover selected files.
Python
5
star
16

cisco-dummy-cli

Interactive dummy JS cisco-like terminal with hints.
JavaScript
4
star
17

4tv

Free OTT WebApp 4TV
Go
3
star
18

wawjs-cheatsheet

wawjs cheat sheet
Shell
2
star
19

iot-honeypot-framework

Scalable Honeypot Framework using Docker Swarm and Elasticsearch.
Python
1
star
20

aria2-traefik

Aria2 with Webui in Docker behind Traefik.
JavaScript
1
star
21

xkb-slovak-layout

Slovak keyboard layout for X.org
1
star