Add hardware requirements and deployment area

This commit is contained in:
Korbs 2024-08-02 17:17:57 -04:00
parent 07fde5d909
commit 6e04a3fa9f

View file

@ -6,6 +6,33 @@ MinPluto is a modern privacy frontend for YouTube and Twitch(planned) giving you
___ ___
## Requirements ## Requirements
### Hardware
| | Minimum | Recommended |
|-------------------|--------------------|------------------|
| CPU Cores | 2 | 4 |
| Memory | 2GB*1 | 8GB |
| Storage | 20GB | 60GB |
| Network Speed | 300Mbps/Upload | 1Gbps/Upload |
| Traffic | 20TB Monthly | Unlimited/No Cap |
> *1: At least have 512Mb free for the operating system.
<details>
<summary>Recommended VPS</summary>
<br>
| Host | Plan | Monthly Pricing | Yearly Pricing |
|------------------|-------------|-------------------|------------------|
| BuyVM | SLICE 4096 | $15.00 | $180.00 |
| Regxa | EVA3 | $15.00 | $171.00 |
> A provider with unlimited bandwidth is preferred.
> All prices are listed in USD.
</details>
### Software
The package manager that you need to use with MinPluto must be [Bun](https://bun.sh/) since it appears to be the most functional option for this project. Attempting to use another package manager like Yarn or PNPM may cause issues, view [Package Managers](#package-managers) in the [Compatibility](#compatibility) section. There seems to be some issues related to both `@astrojs/vue` and `@iconoir/vue`. The package manager that you need to use with MinPluto must be [Bun](https://bun.sh/) since it appears to be the most functional option for this project. Attempting to use another package manager like Yarn or PNPM may cause issues, view [Package Managers](#package-managers) in the [Compatibility](#compatibility) section. There seems to be some issues related to both `@astrojs/vue` and `@iconoir/vue`.
@ -24,6 +51,16 @@ ___
| Yarn v3 | ✅ | ❌ | | Yarn v3 | ✅ | ❌ |
| Yarn v4 | ✅ | ❌ | | Yarn v4 | ✅ | ❌ |
### Deployment
| Software | Build | Run |
|---------------------|-------|------|
Bun (Local) | ✅ | ✅ |
Node (Local) | ✅ | ✅ |
Docker (Local) | ✅ | Mix |
Cloudflare Pages | 🔘 | 🔘 |
> MinPluto can use a lot of bandwidth, which most services will charge extra for. So this list is small and limited to certain services that allow unlimited bandwidth.
### Web Browsers ### Web Browsers
| Browser | Live Streams |Player | CSS | JavaScript | Account System | Embed | | Browser | Live Streams |Player | CSS | JavaScript | Account System | Embed |
|--------------------|--------------|-------|-----|------------|----------------|-------| |--------------------|--------------|-------|-----|------------|----------------|-------|
@ -71,6 +108,7 @@ ___
> *2: Seeking doesn't work > *2: Seeking doesn't work
> *3: Ladybird is a new web browser that is uncompleted. This browser is not expected to work correctly for MinPluto at the moment. > *3: Ladybird is a new web browser that is uncompleted. This browser is not expected to work correctly for MinPluto at the moment.
___ ___
## To Do ## To Do