iridium/neko
2
2
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2024-07-24 14:40:50 +12:00
Code Issues Packages Projects Releases Wiki Activity

added a Digital Ocean tutorial to README

Browse Source
This commit is contained in:
Craig 2020-01-14 12:54:33 +00:00
parent ce5bcb9f76
commit ed773b52bd
1 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -12,15 +12,30 @@ This is a proof of concept project I threw together over the last few days, it's
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.
### Why n.eko?
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 like cats, I'm a weeb/nerd, I own the domain [n.eko.moe](https://n.eko.moe/) and I love the logo /shrug
### I need help setting this up!
Its a docker container, you need to have docker installed, you then need to build the image
### Super easy mode setup
1. Head on to [Digital Ocean](https://digitalocean.com/) and create an account
2. Go [here](https://marketplace.digitalocean.com/apps/docker) and click on "Create Docker Droplet"
3. Configure the droplet:
* **576p** [$15/mo] Not Recommended
* **720p** [$40/mo] Good Performance
* **720p** [$80/mo] Recommended
* **720p+** [$160/mo] Best Performance
4. [Login to the droplet over ssh](https://www.digitalocean.com/docs/droplets/how-to/connect-with-ssh/)
5. Run these commands:
```
cd .docker && ./build
ufw allow 80/tcp
wget https://raw.githubusercontent.com/nurdism/neko/master/docker-compose.yaml
docker-compose up -d
```
5. Visit the IP address of the droplet in your browser and login, the default password is `neko`
Then run the container:
> *Protip*: Run `nano docker-compose.yaml` to edit the settings, then press *ctrl+x* to exit and save the file.
Heres the cool part, this will only cost you a little bit (maybe a few cents), *as long as you remember to delete the droplet after you are done!* Droplets are charged per hour, so when you want to share, just create a new droplet and start sharing.
### Running the container:
```
sudo docker run -p 8080:8080 -e NEKO_PASSWORD='secret' --shm-size=2gb nurdism/neko:latest
```
@ -32,12 +47,13 @@ sudo docker run -p 8080:8080 -e NEKO_PASSWORD='secret' --shm-size=2gb nurdism/ne
NEKO_USER=$USERNAME // User
NEKO_DISPLAY=0 // Display number
NEKO_WIDTH=1280 // Display width
NEKO_HEIGHT=720 // Display width
NEKO_HEIGHT=720 // Display height
NEKO_PASSWORD=neko // Password
NEKO_BIND=0.0.0.0:8080 // Bind
NEKO_KEY= // Key (SSL)
NEKO_CERT= // Cert (SSL)
NEKO_KEY= // (SSL)Key
NEKO_CERT= // (SSL)Cert
```
### Development
*Highly* recommend you use a dev container for vscode, I've included the .devcontainer I've used to develop this app
*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`