netris-nestri/apps/docs/content/3.nestri-relay/3.container-cli.md at 8d18ac9044a0f1c00d56bf31a945b47d1d835860

mirror of https://github.com/nestriness/nestri.git synced 2025-12-12 00:35:38 +02:00

Files

Philipp Neumann 191c59d230 📖 docs: Update README.md (#189 )

## 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>

2025-07-01 05:34:53 +05:00

3.3 KiB

Raw Blame History

title, description, icon

title	description	icon
Container CLI	Configure and manage your Nestri Relay environment using CLI parameters for WebRTC settings, STUN servers, local IP handling, and TLS options.	lucide:terminal

The Nestri Relay CLI provides configuration parameters to manage your relay environment. These options allow you to set values like WebRTC ports, STUN servers, and TLS certificates. Additionally, you can enable verbose mode and debugging for troubleshooting purposes. This documentation details each parameter to help you optimize your relay setup effectively.

Parameters

Parameter	Type	Default	Description
`-v, --verbose`	`boolean`	false	Shows more logs; useful for debugging issues. Recommended before reporting problems.
`-d, --debug`	`boolean`	false	Enables debugging mode for additional logs and troubleshooting insights.
`-p, --endpointPort`	`integer`	8088	Specifies the main port for the relay endpoint.
WebRTC Settings
`--webrtcUDPStart`	`integer`	10000	Defines the starting UDP port for WebRTC connections.
`--webrtcUDPEnd`	`integer`	20000	Defines the ending UDP port for WebRTC connections.
`--webrtcUDPMux`	`integer`	8088	Specifies the WebRTC UDP multiplexing port.
`--stunServer`	`string`	stun.l.google.com:19302	Defines the STUN server address for NAT traversal.
`--autoAddLocalIP`	`boolean`	true	Automatically adds local IP addresses to WebRTC candidates.
`--WEBRTC_NAT_IPS`	`string`	""	Comma-separated list of public IPs for WebRTC NAT traversal (e.g., `"192.168.0.1,192.168.0.2"`).
TLS Configuration
`--tlsCert`	`string`	""	Path to the TLS certificate file for secure connections.
`--tlsKey`	`string`	""	Path to the TLS private key file for secure connections.

3.3 KiB Raw Blame History

Parameters

3.3 KiB

Raw Blame History