mirror of
https://github.com/m1k1o/neko.git
synced 2024-07-24 14:40:50 +12:00
some tweeks
This commit is contained in:
28
README.md
28
README.md
@ -1,3 +1,7 @@
|
||||
<div align="center">
|
||||
<img src="https://github.com/nurdism/neko/raw/master/.github/logo.png" width="650" height="auto"/>
|
||||
</div>
|
||||
|
||||
# n.eko
|
||||
This is a proof of concept project I threw together over the last few days, its ugly its not perfect but it looks nice. This uses web rtc to stream a desktop inside of a docker container, I made this because [rabb.it](https://en.wikipedia.org/wiki/Rabb.it) went under and my internet can't handle streaming and discord keeps crashing. I just want to watch anime with my friends ლ(ಠ益ಠლ) so I started digging throughout the net and found a few *kinda* clones, but non of them had the virtual browser, then I found [Turtus](https://github.com/Khauri/Turtus) and I was able to figure out the rest.
|
||||
|
||||
@ -7,10 +11,28 @@ This is by no means a fully featured clone of rabbit. It has no concept of other
|
||||
I like cats, I'm a weeb and a nerd, I own the domain [n.eko.moe](https://n.eko.moe/) and I love that logo I came across, had to use it for something /shrug
|
||||
|
||||
### I need help setting this up!
|
||||
Its a docker container, you need to have docker installed and then run
|
||||
|
||||
Its a docker container, you need to have docker installed, you then need to build the image
|
||||
```
|
||||
TODO:
|
||||
cd .docker && ./build.sh
|
||||
```
|
||||
|
||||
Then run the container:
|
||||
```
|
||||
sudo docker run -p 8080:8080 --shm-size=2gb neko:latest
|
||||
```
|
||||
|
||||
*Note:* `--shm-size=2gb` is required, firefox-esr tabs will crash (not sure if 2gb is *really* needed)
|
||||
|
||||
### Config
|
||||
```
|
||||
NEKO_USER=$USERNAME // User
|
||||
NEKO_DISPLAY=0 // Display number
|
||||
NEKO_WIDTH=1280 // Display width
|
||||
NEKO_HEIGHT=720 // Display width
|
||||
NEKO_PASSWORD=neko // Password
|
||||
NEKO_BIND=0.0.0.0:8080 // Bind
|
||||
NEKO_KEY= // Key (SSL)
|
||||
NEKO_CERT= // Cert (SSL)
|
||||
```
|
||||
|
||||
### Development
|
||||
|
Reference in New Issue
Block a user