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/getting-started/quick-start.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

2021-10-24 02:54:58 +13:00
# Quick Start
2020-02-10 13:59:08 +13:00
2021-10-24 02:54:58 +13:00
1. Deploy a server or VPS.
2020-02-10 13:59:08 +13:00
**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.
2021-10-24 02:54:58 +13:00
*Note:* Admin can change the resolution in the GUI.
2020-02-10 13:59:08 +13:00
2021-10-24 02:54:58 +13:00
2. [Login via SSH](https://www.digitalocean.com/docs/droplets/how-to/connect-with-ssh/).
2020-02-10 13:59:08 +13:00
2021-10-24 02:54:58 +13:00
3. Install [Docker](https://docs.docker.com/get-docker/):
2020-02-10 13:59:08 +13:00
```shell
curl -sSL https://get.docker.com/ | CHANNEL=stable bash
```
2021-10-24 02:54:58 +13:00
4. Install [Docker Compose](https://docs.docker.com/compose/install/):
2020-02-10 13:59:08 +13:00
```shell
2021-10-24 02:54:58 +13:00
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
5. Download docker compose file and start it:
```shell
wget https://raw.githubusercontent.com/m1k1o/neko/master/docker-compose.yaml
2020-02-10 13:59:08 +13:00
sudo docker-compose up -d
```
2021-10-24 02:54:58 +13:00
6. Visit the IP address server in your browser and login, the default password is `neko`.
2020-02-10 13:59:08 +13:00
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)
* [Digital Ocean](https://www.digitalocean.com/)
2021-10-24 02:54:58 +13:00
* [Contabo](https://contabo.com/)
2020-02-10 14:58:24 +13:00
* [Linode](https://www.linode.com/)
2021-10-24 02:54:58 +13:00
* [Vultr](https://www.vultr.com/)