3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-04-28 18:06:20 +02:00
Code Issues Projects Releases Packages Wiki Activity
neko/webpage/docs/intro.md
Miroslav Šedivý d094bebe45 WIP add docusaurus webpage.
2025-02-01 19:10:47 +01:00

1.9 KiB
Raw Blame History

sidebar_position
1

Quick Start

Neko is easy to use and requires no technical expertise to get started. All you need to do is download the Docker image and you're ready to go:

  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

    :::danger[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 Admin can change the resolution in the GUI. :::

  2. Login via SSH.

  3. Install Docker:

    curl -sSL https://get.docker.com/ | CHANNEL=stable bash

  4. Install Docker Compose Plugin:

    sudo apt-get update
sudo apt-get install docker-compose-plugin

  5. Download docker compose file and start it:

    wget https://raw.githubusercontent.com/m1k1o/neko/master/docker-compose.yaml
sudo docker compose up -d

  6. Visit the IP address server in your browser and login, the default password is neko.

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

Well known cloud providers