enricobuehler
f3555d5eb5
apple / swift (push) Successful in 55s
ci / web (push) Successful in 45s
ci / docs-site (push) Successful in 1m18s
ci / rust (push) Successful in 4m14s
deb / build-publish (push) Successful in 2m16s
decky / build-publish (push) Successful in 12s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 6s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 23s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 3s
ci / bench (push) Successful in 4m40s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 4s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 46s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 8m35s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Successful in 8m18s
docker / deploy-docs (push) Successful in 19s
android / android (push) Successful in 3m12s
Move the management console (web/) off shadcn/ui to the shared @unom/ui design system the marketing site + docs are built on, on the punktfunk violet brand over dark chrome: - Add @unom/ui/@unom/style/motion/radix-ui/zod + Geist; web/.npmrc maps the @unom scope (packages are public-read, so CI needs no npm auth). - styles.css: one dark-violet palette (#141019/#1c1530, brand #6c5bf3 -> #a79ff8) exposed under BOTH the shadcn token names the routes use and @unom/ui's contract, so routes + components both resolve; pulls in @unom/ui's material gloss + easings. - components/ui/* now back onto @unom/ui (AnimatedButton/InputText/Label/ AnimatedCard); brand-mark/wordmark/logo replace the generic Radio icon in the shell + login. - MaterialProvider (specular gloss) at the root. No UI sounds, like the site. docs-site: new /api route renders the host management REST API as an interactive Scalar reference (reads public/openapi.json, a snapshot of docs/api/openapi.json), branded violet and linked from the top nav, the docs sidebar, the landing page, and host-cli.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
45 lines
2.7 KiB
Plaintext
45 lines
2.7 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Low-latency desktop and game streaming from a Linux host to any of your devices.
|
|
---
|
|
|
|
import { Cards, Card } from 'fumadocs-ui/components/card'
|
|
|
|
**punktfunk** streams your Linux desktop or games to your other devices — a laptop, a Mac, a tablet,
|
|
a TV — at low latency and at **each device's own resolution and refresh rate**. Run the host on a
|
|
Linux machine with an NVIDIA GPU, connect a client, and you're streaming.
|
|
|
|
It's built for the things that make streaming feel native:
|
|
|
|
- **Your device's exact mode.** The host spins up a virtual display sized to the client that's
|
|
connecting — 1080p60 to your laptop, 1440p120 to your desktop, 4K to your TV — at the same time.
|
|
No letterboxing, no scaling, no juggling your real monitors.
|
|
- **Low latency, GPU end to end.** Frames go straight from the compositor to the GPU encoder
|
|
(NVENC) with zero CPU copies, and over a transport tuned for responsiveness rather than throughput.
|
|
- **Works with the apps you already have.** punktfunk speaks the GameStream protocol, so any
|
|
**Moonlight** client connects out of the box — and a faster **native protocol** with dedicated apps
|
|
for **macOS, iOS, tvOS, Linux, Windows, and Android**.
|
|
- **Secure by default.** Hosts require a one-time PIN pairing; after that, devices reconnect on a
|
|
pinned identity. No accounts, no cloud.
|
|
|
|
## Pick your path
|
|
|
|
<Cards>
|
|
<Card title="How It Works" href="/docs/how-it-works" description="The ideas behind punktfunk in a few minutes — virtual displays, the two protocols, pairing." />
|
|
<Card title="Quick Start" href="/docs/quickstart" description="From nothing to streaming: set up a host and connect your first client." />
|
|
<Card title="Host Setup" href="/docs/requirements" description="Install the host on Ubuntu (GNOME or KDE), Fedora (KDE), or Bazzite." />
|
|
<Card title="Connect a Client" href="/docs/clients" description="Stream with the native app for your device — macOS, Linux, Windows, Android — or any Moonlight client." />
|
|
<Card title="API Reference" href="/api" description="Interactive OpenAPI reference for the host's management REST API — status, devices, pairing, library." />
|
|
</Cards>
|
|
|
|
## What you need
|
|
|
|
- A **Linux host** with an **NVIDIA GPU** (for the NVENC hardware encoder) running one of the
|
|
[supported setups](/docs/requirements): **Ubuntu** (GNOME or KDE), **Fedora** (KDE), or **Bazzite**.
|
|
A native [**Windows host**](/docs/windows-host) (NVIDIA-only) is also available.
|
|
- A **client device** to stream to — there are native apps for **macOS, iOS/iPadOS, tvOS, Linux,
|
|
Windows, and Android**, plus any device that runs **Moonlight**.
|
|
- Both on the **same network** (LAN or VPN). punktfunk is designed for a trusted local network.
|
|
|
|
Ready? Head to the [Quick Start](/docs/quickstart).
|