mirror of
https://github.com/nestriness/nestri.git
synced 2025-12-12 08:45:38 +02:00
Documentation for Nestri (#116)
I have made documentation for Nestri, so everybody easy can find instructions to get started. It will also make it easier for people to help contribute to the documentation. The documentation is built with Nuxt3, [Docus ](https://github.com/nuxt-themes) which uses Nuxt Content.  
This commit is contained in:
committed by
GitHub
parent
bae089e223
commit
390ee2ac0f
9
apps/docs/content/2.nestri-node/1.what-is-nestri-node.md
Normal file
9
apps/docs/content/2.nestri-node/1.what-is-nestri-node.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# What is Nestri Node?
|
||||
|
||||
Nestri Node is the core component of Nestri's self-hosted cloud-gaming solution, designed for users who want the freedom and flexibility of running their own game-streaming server. Similar to services like NVIDIA GeForce Now, Nestri allows you to play your games remotely via your browser. However, unlike other cloud-gaming platforms, Nestri is fully self-hosted, giving you complete control over your server and gaming experience.
|
||||
|
||||
The Nestri Node is the actual server where you install your games. Once set up, you can stream and play your games remotely from any compatible device. It runs on machines with Linux and requires an NVIDIA, AMD or an Intel graphics card .
|
||||
## ⚠️ Important Note
|
||||
|
||||
We recommend not installing Nestri Node on your primary PC if you only intend to use it over a weekend. This is because Nestri Node cannot run simultaneously with Xorg, the display server responsible for managing the graphical user interface (GUI). This means that while Nestri Node is running, you will not be able to use an attached screen. For this reason, Nestri Node is best set up on a dedicated machine that won’t be used for other tasks.
|
||||
|
||||
51
apps/docs/content/2.nestri-node/2.prerequisite.md
Normal file
51
apps/docs/content/2.nestri-node/2.prerequisite.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# Prerequisite
|
||||
|
||||
In order to run Nestri on your own server, there are a few things you need to prepare before you can start installing nestri-node. On this page we go through the requirements needed to get started with Nestri.
|
||||
|
||||
Although it may be very tempting to skip this step, you shouldn't! You will save yourself a lot of headaches and wasted hours because something doesn't work due to lack of setup beforehand.
|
||||
|
||||
## Hardware Requirements
|
||||
|
||||
::list{type="primary"}
|
||||
- **NVIDIA GPU**
|
||||
- **8GB Memory**
|
||||
- **Linux** (We Recommend Ubuntu Desktop 22.04)
|
||||
::
|
||||
|
||||
## Software Requirements
|
||||
|
||||
::list{type="primary"}
|
||||
- **Nvidia Drivers**
|
||||
- **[NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#installing-with-apt)**
|
||||
- **[Docker](https://linuxiac.com/how-to-install-docker-on-ubuntu-24-04-lts/)**
|
||||
|
||||
::
|
||||
|
||||
## Disconnect monitor
|
||||
Since Nestri requires access to your GPU, then you need to unplug you screen from it.
|
||||
If you want to see the Desktop and have a integrated graphicscard in your CPU, then you can connect your monitor to the motherboard.
|
||||
### Change the Default Boot Target to Multi-User (Non-GUI Mode)
|
||||
Ubuntu typically starts in graphical mode (using the graphical.target systemd target). You should change to the non-graphical multi-user.target, which will prevent Xorg from starting.
|
||||
|
||||
1. Open a terminal or access your system via SSH.
|
||||
2. To check your current default target (which should be graphical.target)
|
||||
|
||||
```bash
|
||||
systemctl get-default
|
||||
|
||||
```
|
||||
|
||||
3. Change the default target to multi-user.target (which corresponds to text mode, without Xorg):
|
||||
```bash
|
||||
sudo systemctl set-default multi-user.target
|
||||
|
||||
|
||||
```
|
||||
|
||||
4. Reboot the system
|
||||
|
||||
5. Verify that Xorg is not running
|
||||
```bash
|
||||
nvidia-smi
|
||||
```
|
||||
|
||||
30
apps/docs/content/2.nestri-node/3.getting-started.md
Normal file
30
apps/docs/content/2.nestri-node/3.getting-started.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Getting Started
|
||||
|
||||
::alert{type="danger"}
|
||||
Nestri is in a **very early-beta phase**, so errors and bugs may occur.
|
||||
::
|
||||
<!--
|
||||
Nestri Node is easy to install using the provided installation script. Follow the steps below to get started.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download the installation script using `wget`:
|
||||
|
||||
```bash
|
||||
wget https://github.com/nestriness/nestri/nestri-node-install.sh
|
||||
|
||||
```
|
||||
|
||||
2. Make the script executable:
|
||||
```bash
|
||||
chmod +x nestri-node-install.sh
|
||||
|
||||
|
||||
```
|
||||
3. Run the script to start the installation process:
|
||||
```bash
|
||||
./nestri-node-install.sh
|
||||
```
|
||||
::-->
|
||||
|
||||
|
||||
2
apps/docs/content/2.nestri-node/4.troubleshooting.md
Normal file
2
apps/docs/content/2.nestri-node/4.troubleshooting.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# Troubleshooting
|
||||
|
||||
2
apps/docs/content/2.nestri-node/_dir.yml
Normal file
2
apps/docs/content/2.nestri-node/_dir.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
title: 'Nestri Node'
|
||||
icon: heroicons-outline:bookmark-alt
|
||||
Reference in New Issue
Block a user