neko/docs/quick-start.md

40 lines
1.6 KiB
Markdown
Raw Normal View History

2020-02-10 13:59:08 +13:00
# Quick Start (WIP)
1. Deploy a server or VPS
**Recommended Specs:**
| Resolution | Cores | Ram | Recommendation |
|-------------|-------|-------|------------------|
| 1024×576@30 | 2 | 2gb | Not Recommended |
2020-02-10 14:58:24 +13:00
| 1280x720@30 | 4 | 3gb | Good Performance |
| 1280x720@30 | 6 | 4gb | Recommended |
| 1280x720@30 | 8 | 4gb+ | Best Performance |
2020-02-10 13:59:08 +13:00
*Why are the specs so high?* : If you think about it, you have to run a full desktop, a browser (a resource hog on its own) *and* encode/transmit the desktop, there's a lot going on and so it demands some power.
*Note:* changing the resolution will require additional setup
2. [Login via SSH](https://www.digitalocean.com/docs/droplets/how-to/connect-with-ssh/)
3. Install Docker
```shell
curl -sSL https://get.docker.com/ | CHANNEL=stable bash
```
4. Run these commands:
```shell
sudo ufw allow 80/tcp # if you have ufw installed/enabled
sudo ufw allow 59000:59100/udp
wget https://raw.githubusercontent.com/nurdism/neko/master/docker-compose.yaml
sudo docker-compose up -d
```
5. Visit the IP address server in your browser and login, the default password is `neko`
2020-02-10 14:58:24 +13:00
> 💡 **Protip**: Run `nano docker-compose.yaml` to edit the settings, then press `ctrl+x` to exit and save the file.
## Well known cloud providers
* [Hetzner Cloud](https://www.hetzner.com/cloud)
* [Scaleway](https://www.scaleway.com/)
* [Digital Ocean](https://www.digitalocean.com/)
* [Linode](https://www.linode.com/)
* [Vultr](https://www.vultr.com/)