Getting Started

Follow this guide to set up and run your own Nestri Node for cloud gaming.

Step 1: Create a home directory for your Nestri Node

This will be the directory where Steam, games and other persistent files will be saved. You may use any directory you like, but for simplicity, we will use ~/nestri as the home directory in this guide.

create home directory command
mkdir -p ~/nestri
sudo chmod 777 ~/nestri

The above will create a directory called nestri in your home directory and set the permissions to allow read, write, and execute for all users. This is important for the Nestri Node to function properly.

Step 2: Launch the Nestri Runner

With your home directory ready, insert it into the command below, replacing <relay_url> with the relay's URL you want to use. You will also need to replace <room_name> with an unique name for the room you will be using to play your games.

run container (nvidia)
podman run --replace -d --name=nestri --shm-size=6g --cap-add=SYS_NICE --device /dev/dri/ -e RELAY_URL='<relay_url>' -e NESTRI_ROOM='<room_name>' -e RESOLUTION=1920x1080 -e FRAMERATE=60 -e NESTRI_PARAMS='--verbose=true --dma-buf=true --audio-rate-control=cbr --video-codec=h264 --video-rate-control=cbr --video-bitrate=8000' -v ~/nestri:/home/nestri --device /dev/nvidia-uvm --device /dev/nvidia-uvm-tools --device /dev/nvidiactl --device /dev/nvidia0 --device /dev/nvidia-modeset ghcr.io/nestrilabs/nestri/runner:nightly
run container (amd/intel)
podman run --replace -d --name=nestri --shm-size=6g --cap-add=SYS_NICE --device /dev/dri/ -e RELAY_URL='<relay_url>' -e NESTRI_ROOM='<room_name>' -e RESOLUTION=1920x1080 -e FRAMERATE=60 -e NESTRI_PARAMS='--verbose=true --dma-buf=true --audio-rate-control=cbr --video-codec=h264 --video-rate-control=cbr --video-bitrate=8000' -v ~/nestri:/home/nestri ghcr.io/nestrilabs/nestri/runner:nightly

Step 3: Begin Playing

Finally, construct the play URL with your room name and relay URL: https://nestri.io/play/<room_name>?peerURL=<relay_url>

Navigate to this URL in your browser, click on the button to capture your mouse pointer and keyboard, and start playing!

Stop the Nestri Container

If you want to stop the Nestri container, you can use the following command:

stop container command
podman stop nestri

Start the Nestri Container

If you want to start the Nestri container after stopping it, you can use the following command:

start container command
podman start nestri

Remove the Nestri Container

To remove the container, you can use the following command:

remove container command
podman rm nestri

Update Nestri Container

To update the Nestri container, you can use the following command:

update container command
podman pull ghcr.io/nestrilabs/nestri/runner:nightly

After which, you can recreate the container with the latest image using the same command you used in Step 2.

Prerequisites
Essential system and software requirements for setting up Nestri on your server, including GPU compatibility, OS recommendations, and necessary configurations.
Troubleshooting