iridium/neko-custom
Archived
2
0
Fork 0
Code Pull Requests Activity

docs (wip)

Browse Source
This commit is contained in:
Craig
2020-02-10 01:58:24 +00:00
parent 2615ccc529
commit 15e490a72f
4 changed files with 36 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -1,5 +1,5 @@
<div align="center">
<img src="_media/logo.png" width="450" height="auto"/>
<a href="https://n.eko.moe/#/" ><img src="https://raw.githubusercontent.com/nurdism/neko/master/docs/_media/logo.png" width="450" height="auto"/></a>
<br/>
<br/>
<img src="https://i.imgur.com/ZSzbQr7.gif" width="650" height="auto"/>

15
docs/quick-start.md
View File

@ -7,9 +7,9 @@
| Resolution | Cores | Ram | Recommendation |
|-------------|-------|-------|------------------|
| 1024×576@30 | 2 | 2gb | Not Recommended |
| 1280x720@30 | 4 | 4gb | Good Performance |
| 1280x720@30 | 6 | 4-6gb | Recommended |
| 1280x720@30 | 8 | 8gb+ | Best Performance |
| 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.
@ -30,4 +30,11 @@
```
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.
> 💡 **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/)