mirror of
https://github.com/m1k1o/neko-rooms.git
synced 2026-11-02 22:51:34 -06:00
Miroslav Šedivý
121 lines
3.6 KiB
Markdown
121 lines
3.6 KiB
Markdown
# 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](https://github.com/m1k1o/neko). 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
|
|
|
|
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.
|
|
|
|
```bash
|
|
curl https://raw.githubusercontent.com/m1k1o/neko-rooms/master/install | sudo bash
|
|
```
|
|
|
|
## How to start
|
|
|
|
You need to have installed `Docker` and `docker-compose`. You need to have a custom domain pointing to your server's IP.
|
|
|
|
You can watch installation video provided by *Dr R1ck*:
|
|
|
|
https://www.youtube.com/watch?v=cCmnw-pq0gA
|
|
|
|
### Installation guide
|
|
|
|
You only need `.env.example`, `docker-compose.yml` and `traefik/`.
|
|
|
|
#### Do I need to use traefik?
|
|
|
|
- Traefik needs to be used to forward traffic to the rooms. You can put nginx in front of it, but not replace it.
|
|
- Your domain name specified for traefik must match the domain name, that your proxy connects to. In docker-compose it is the service name.
|
|
- See example configuration for [nginx](docs/nginx).
|
|
|
|
You can use `docker-compose.http.yml` that will expose this service to `8080` or any port. Authentication is optional.
|
|
|
|
### Step 1
|
|
|
|
Copy `.env.example` to `.env` and customize.
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
### Step 2
|
|
|
|
Create `usersfile` with your users:
|
|
|
|
```bash
|
|
touch traefik/usersfile
|
|
```
|
|
|
|
And add as many users as you like:
|
|
|
|
```bash
|
|
echo $(htpasswd -nb user password) >> traefik/usersfile
|
|
```
|
|
|
|
### Step 3 (HTTPS only)
|
|
|
|
Create `acme.json`
|
|
|
|
```bash
|
|
touch traefik/acme.json
|
|
chmod 600 traefik/acme.json
|
|
```
|
|
|
|
Update your email in `traefik/traefik.yml`.
|
|
|
|
### 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).
|
|
|
|
```sh
|
|
docker pull m1k1o/neko:latest
|
|
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:
|
|
|
|
```sh
|
|
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](./docs/storage.md).
|
|
|
|
### Roadmap:
|
|
- [x] add GUI
|
|
- [x] add HTTPS support
|
|
- [x] add authentication provider for traefik
|
|
- [x] allow specifying custom ENV variables
|
|
- [x] allow mounting directories for persistent data
|
|
- [ ] 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
|