Skip to content

Commit

Permalink
feat: add NGINX installer and update README (#146)
Browse files Browse the repository at this point in the history
* feat: add NGINX installer script for zero-knowledge setup

- Created a new installer script for NGINX-based setups.
- The script automates Docker, NGINX, Let's Encrypt, and Neko Rooms configuration.
- Designed for users who prefer NGINX as a reverse proxy instead of Traefik.

* docs: update README to include zero-knowledge installation instructions with NGINX

* feat: enhance IP retrieval method and add user prompt for domain continuation

* docs: update README to streamline zero-knowledge installation instructions and clarify NGINX usage

* feat: update IP retrieval fallback service to use checkip.amazonaws.com
  • Loading branch information
H1ghSyst3m authored Jan 14, 2025
1 parent fd03fb6 commit 30d9dc7
Show file tree
Hide file tree
Showing 2 changed files with 814 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,25 @@ 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 (with HTTPS and Traefik)
## Zero-knowledge installation (with HTTPS)

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!
No experience with Docker and reverse proxy? No problem! Follow these steps to set up your Neko Rooms quickly and securely:

- 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.
- Secure using HTTPs thanks to Let's Encrypt and Traefik or NGINX.

### Traefik version
```bash
wget -O neko-rooms.sh https://raw.githubusercontent.com/m1k1o/neko-rooms/master/traefik/install
sudo bash neko-rooms.sh
wget -O neko-rooms-traefik.sh https://raw.githubusercontent.com/m1k1o/neko-rooms/master/traefik/install
sudo bash neko-rooms-traefik.sh
```

### NGINX version
```bash
wget -O neko-rooms-nginx.sh https://raw.githubusercontent.com/m1k1o/neko-rooms/master/nginx/install
sudo bash neko-rooms-nginx.sh
```

## How to start
Expand Down
Loading

0 comments on commit 30d9dc7

Please sign in to comment.