Archived
2
0
This repository has been archived on 2024-06-24. You can view files and clone it, but cannot push or open issues or pull requests.
neko-custom/docs/quick-start.md
2020-02-10 01:58:24 +00:00

1.6 KiB
Raw Blame History

Quick Start (WIP)

  1. Deploy a server or VPS

    Recommended Specs:

    Resolution Cores Ram Recommendation
    1024×576@30 2 2gb Not Recommended
    1280x720@30 4 3gb Good Performance
    1280x720@30 6 4gb Recommended
    1280x720@30 8 4gb+ Best Performance

    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

  3. Install Docker

    curl -sSL https://get.docker.com/ | CHANNEL=stable bash
    
  4. Run these commands:

    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

💡 Protip: Run nano docker-compose.yaml to edit the settings, then press ctrl+x to exit and save the file.

Well known cloud providers