neko-rooms/README.md

neko-rooms

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

How to start

You need to have installed Docker and docker-compose. You need to have 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

Step 1

Copy .env.example to .env and customize.

cp .env.example .env

Step 2

Create usersfile with your users:

touch traefik/usersfile

And add as many users as you like:

echo $(htpasswd -nb user password) >> traefik/usersfile

Step 3

Create acme.json

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

Update your email in traefik/traefik.yml.

Roadmap:

• add GUI
• add HTTPS support
• add authentication provider for traefik
• add bearer token to for API
• add docker ssh / tcp support
• add docker swarm support