Skip to content

Commit

Permalink
add zero-knowledge installation to readme #7.
Browse files Browse the repository at this point in the history
  • Loading branch information
m1k1o committed May 22, 2021
1 parent e21cbb2 commit fb7b443
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ Simple room management system for [n.eko](https://github.com/m1k1o/neko). Self h
<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 custom domain pointing to your server's IP.
Expand Down

0 comments on commit fb7b443

Please sign in to comment.