iridium/neko-custom
Archived
2
0
Fork 0
Code Pull Requests Activity

new docker image

Browse Source
This commit is contained in:
Craig 2020-01-23 17:29:20 +00:00
parent 064253eae3
commit a0866a4ab9
3 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.docker/build
View File

@ -9,6 +9,7 @@ npm install && npm run build
cd ../
sudo docker build -f Dockerfile -t nurdism/neko .
# sudo docker push nurdism/neko:latest
# sudo docker run -p 8080:8080 --shm-size=1gb nurdism/neko:latest
# sudo docker run --network host --shm-size=1gb nurdism/neko:latest
# sudo docker run --network host --shm-size=1gb -it nurdism/neko:latest /bin/bash

1
Dockerfile
View File

@ -68,6 +68,7 @@ ENV NEKO_DISPLAY=0
ENV NEKO_WIDTH=1280
ENV NEKO_HEIGHT=720
ENV NEKO_PASSWORD=neko
ENV NEKO_ADMIN=admin
ENV NEKO_BIND=:8080
# Neko Nyan (=^-ω-^=)

12
README.md
View File

@ -3,13 +3,11 @@
</div>
<div align="center">
<img src="https://github.com/nurdism/neko/raw/master/.github/demo.gif" width="650" height="auto"/>
<img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/>
</div>
# **n**.eko
This is a proof of concept project I threw together over the last few days, it's 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.
This is by no means a fully featured clone of rabbit. The client has no concept of other peers. It has bugs, but for the most part it works. I'm not sure what the future holds for this. If I continue to use it and like it, I'll probably keep pushing updates to it. I'd be happy to accept PRs for any improvements.
This is a proof of concept project I threw together over the last few days, it's 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. This is by no means a fully featured clone of rabbit, it hs only *one* room. Its stateless, so no saved user names or passwords.
### Why n.eko?
I like cats (Neko is the Japanese word for cat), I'm a weeb/nerd, I own the domain [n.eko.moe](https://n.eko.moe/) and I love the logo /shrug
@ -44,7 +42,7 @@ I like cats (Neko is the Japanese word for cat), I'm a weeb/nerd, I own the doma
### Running the container:
```
sudo docker run -p 8080:8080 -e NEKO_PASSWORD='secret' --shm-size=1gb nurdism/neko:latest
sudo docker run -p 8080:8080 -e NEKO_PASSWORD='secret' -e NEKO_ADMIN='secret' --shm-size=1gb nurdism/neko:latest
```
*Note:* `--shm-size=1gb` is required, firefox-esr tabs will crash
@ -56,6 +54,7 @@ NEKO_DISPLAY=0 // Display number
NEKO_WIDTH=1280 // Display width
NEKO_HEIGHT=720 // Display height
NEKO_PASSWORD=neko // Password
NEKO_ADMIN=neko // Admin Password
NEKO_BIND=0.0.0.0:8080 // Bind
NEKO_KEY= // (SSL)Key
NEKO_CERT= // (SSL)Cert
@ -64,3 +63,6 @@ NEKO_CERT= // (SSL)Cert
### Development
*Highly* recommend you use a [dev container](https://code.visualstudio.com/docs/remote/containers) for [vscode](https://code.visualstudio.com/), I've included the `.devcontainer` I've used to develop this app. To build neko run:
`cd .docker && ./build`
### Non Goals
* Turning n.eko into a service that serves multiple rooms and browsers/desktops.