{"id":13581864,"url":"https://github.com/m1k1o/neko-rooms","last_synced_at":"2025-04-13T08:56:38.108Z","repository":{"id":36975044,"uuid":"345484146","full_name":"m1k1o/neko-rooms","owner":"m1k1o","description":"Selfhosted collaborative browser - room management for n.eko","archived":false,"fork":false,"pushed_at":"2025-04-04T21:09:07.000Z","size":6255,"stargazers_count":525,"open_issues_count":23,"forks_count":71,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-06T05:09:11.495Z","etag":null,"topics":["borwser","docker","golang","self-hosted","virtual-browser"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m1k1o.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["m1k1o"]}},"created_at":"2021-03-08T00:13:39.000Z","updated_at":"2025-04-05T05:07:07.000Z","dependencies_parsed_at":"2023-01-17T10:31:24.635Z","dependency_job_id":"2688a5de-4cda-41d0-ab21-759ef1ae63da","html_url":"https://github.com/m1k1o/neko-rooms","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1k1o%2Fneko-rooms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1k1o%2Fneko-rooms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1k1o%2Fneko-rooms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1k1o%2Fneko-rooms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m1k1o","download_url":"https://codeload.github.com/m1k1o/neko-rooms/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248688544,"owners_count":21145764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["borwser","docker","golang","self-hosted","virtual-browser"],"created_at":"2024-08-01T15:02:17.117Z","updated_at":"2025-04-13T08:56:38.081Z","avatar_url":"https://github.com/m1k1o.png","language":"Go","funding_links":["https://github.com/sponsors/m1k1o"],"categories":["Go"],"sub_categories":[],"readme":"# neko-rooms\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/v/release/m1k1o/neko-rooms\" alt=\"release\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/license/m1k1o/neko-rooms\" alt=\"license\"\u003e\n  \u003cimg src=\"https://img.shields.io/docker/pulls/m1k1o/neko-rooms\" alt=\"pulls\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues/m1k1o/neko-rooms\" alt=\"issues\"\u003e\n  \u003ca href=\"https://discord.gg/3U6hWpC\" \u003e\u003cimg src=\"https://discordapp.com/api/guilds/665851821906067466/widget.png\" alt=\"Chat on discord\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nSimple room management system for [n.eko](https://github.com/m1k1o/neko). Self hosted rabb.it alternative.\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/m1k1o/neko-rooms/raw/master/docs/rooms.png\" alt=\"rooms\"\u003e\n  \u003cimg src=\"https://github.com/m1k1o/neko-rooms/raw/master/docs/new_room.png\" alt=\"new room\"\u003e\n  \u003cimg src=\"https://github.com/m1k1o/neko-rooms/raw/master/docs/neko.gif\" alt=\"n.eko\"\u003e\n\u003c/div\u003e\n\n## Zero-knowledge installation (with HTTPS)\n\nNo experience with Docker and reverse proxy? No problem! Follow these steps to set up your Neko Rooms quickly and securely:\n\n- Rent a VPS with public IP and OS Ubuntu.\n- Get a domain name pointing to your IP (you can even get some for free).\n- Run install script and follow instructions.\n- Secure using HTTPs thanks to Let's Encrypt and Traefik or NGINX.\n\n```bash\nwget -O neko-rooms-traefik.sh https://raw.githubusercontent.com/m1k1o/neko-rooms/master/traefik/install\nsudo bash neko-rooms-traefik.sh\n```\n\n### Community Installation Scripts\n\nWe have community-contributed installation scripts available. Check out our [community installation guides](./community/README.md) for instructions on installing neko-rooms on various Linux distributions. These scripts are maintained by the community and support different Linux distributions like Arch Linux, Fedora, and more.\n\n## How to start\n\nIf you want to use Traefik as reverse proxy, visit [installation guide for traefik as reverse proxy](./traefik/).\n\nOtherwise modify variables in `docker-compose.yml` and just run `docker-compose up -d`.\n\n### Download images / update\n\nYou 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).\n\n```sh\ndocker pull ghcr.io/m1k1o/neko/firefox\ndocker pull ghcr.io/m1k1o/neko/chromium\n# etc...\n```\n\nIf 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:\n\n```sh\ndocker-compose pull\ndocker-compose up -d\n```\n\n### Enable storage\n\nYou might have encountered this error:\n\n\u003e Mounts cannot be specified because storage is disabled or unavailable.\n\nIf you didn't specify storage yet, you can do it using [this tutorial](./docs/storage.md).\n\n### Use nvidia GPU\n\nIf you want to use nvidia GPU, you need to install [nvidia-docker](https://github.com/NVIDIA/nvidia-docker).\n\nChange neko images to nvidia images in `docker-compose.yml` using envorinment variable `NEKO_ROOMS_NEKO_IMAGES`:\n\n```bash\nNEKO_ROOMS_NEKO_IMAGES=\"\n  ghcr.io/m1k1o/neko/nvidia-chromium:latest\n  ghcr.io/m1k1o/neko/nvidia-google-chrome:latest\n  ghcr.io/m1k1o/neko/nvidia-microsoft-edge:latest\n  ghcr.io/m1k1o/neko/nvidia-brave:latest\n\"\n```\n\nWhen creating new room, you need to specify to use GPU in expext settings.\n\n### Docs\n\nFor more information visit [docs](./docs).\n\n### Roadmap:\n - [x] add GUI\n - [x] add HTTPS support\n - [x] add authentication provider for traefik\n - [x] allow specifying custom ENV variables\n - [x] allow mounting directories for persistent data\n - [x] optionally remove Traefik as dependency\n - [ ] add upgrade button\n - [ ] auto pull images, that do not exist\n - [ ] add bearer token to for API\n - [ ] add docker SSH / TCP support\n - [ ] add docker swarm support\n - [ ] add k8s support\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm1k1o%2Fneko-rooms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm1k1o%2Fneko-rooms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm1k1o%2Fneko-rooms/lists"}