mirror of
https://github.com/nestriness/nestri.git
synced 2025-12-12 16:55:37 +02:00
191c59d230
## Description Update the readme file ## Related Issues none ## Type of Change - [ ] Bug fix (non-breaking change) - [ ] New feature (non-breaking change) - [ ] Breaking change (fix or feature that changes existing functionality) - [x] Documentation update - [ ] Other (please describe): ## Checklist - [x] I have updated relevant documentation - [x] My code follows the project's coding style - [x] My changes generate no new warnings/errors ## Notes for Reviewers none ## Screenshots/Demo none ## Additional Context none <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Major overhaul of documentation structure and content for improved clarity, modern presentation, and ease of navigation. - Updated and expanded guides for installation, setup, architecture, and command-line interfaces. - Enhanced FAQ and troubleshooting sections with more comprehensive answers and technical details. - Added new guides for self-hosting with reverse proxy examples (Caddy, Traefik) and developer notes. - Improved theming, styling, and home page layout for the documentation site. - Simplified main README to a minimalistic project header and tagline. - Added new documentation files for Nestri Relay introduction and container CLI parameters. - Removed outdated or redundant documentation files and components to streamline content. - **Chores** - Updated, reorganized, or removed configuration files for dependencies, linting, and environment setup. - Switched to a new documentation theme and updated related project dependencies. - Removed Renovate configuration and ESLint config specific to docs app. - Adjusted TypeScript and package configurations for better compatibility. - **Style** - Improved dark mode support and visual consistency across documentation and components. - Introduced new Tailwind CSS theming and animation support for the documentation site. - **New Features** - Added example configuration files for deploying Nestri Relay with Caddy and Traefik reverse proxies. - Introduced new Tailwind CSS theming and animation support for the documentation site. - Added a new logo component supporting light/dark mode and optional title display. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Victor Pahuus Petersen <49293748+victorpahuus@users.noreply.github.com> Co-authored-by: Wanjohi <elviswanjohi47@gmail.com> Co-authored-by: DatCaptainHorse <DatCaptainHorse@users.noreply.github.com>
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
---
|
|
title: Developer Notes and Tips
|
|
description: This is a collection of developer notes for Nestri Node.
|
|
icon: 'lucide:wrench'
|
|
|
|
---
|
|
|
|
### Construct The Nestri Runner Docker Image
|
|
Checkout your branch with the latest version of nestri and build the image `<your-nestri-image>` within git root folder:
|
|
```bash [build docker image command]
|
|
podman build -t <your-nestri-image>:latest -f containers/Containerfile.runner .
|
|
```
|
|
|
|
### Running other applications besides Steam
|
|
When you followed the getting started guide, you already have a container running. You can get into your container to start your games or other applications:
|
|
```bash [get into container command]
|
|
podman exec -it nestri /bin/bash
|
|
```
|
|
|
|
For most games that are not DRM free you need a launcher. In this case use the umu launcher:
|
|
```bash [install umu and mangohud command]
|
|
pacman -S umu-launcher
|
|
```
|
|
|
|
You have to execute your game with the nestri user. If you have a linux game execute it like so:
|
|
```bash [execute game command]
|
|
su nestri
|
|
source /etc/nestri/envs.sh
|
|
GAMEID=0 PROTONPATH=GE-Proton mangohud umu-run <your-game.exe>
|
|
```
|
|
|
|
You could also use other launchers like Lutris to run other games.
|
|
|
|
::alert{type="danger"}
|
|
**Warning:** Running other applications besides Steam is not supported and may cause issues. We cannot provide support for this.
|
|
:: |