Skip to content
Pithyx

Pithyx documentation

View as Markdown

Pick an area below. Every page also exists as plain Markdown: add .md to its address, or use the buttons under the title.

Getting startedWhat Pithyx is, the hardware it needs and the quickest way to a running box.
Using PithyxThe web desktop for everyday users: windows, files, apps and the own account.
AdministrationRunning a box: users and groups, permissions, storage, shared folders, file services, network, apps and backups.
Install and updateThe USB stick, firmware and boot, the web installer, the first setup and system updates.
DaemonThe C# daemon: architecture, API, errors, logging and tests.
DesktopThe React web desktop: structure, translations, theming, window manager and budgets.
App developmentWriting, building and publishing apps: pithyx dev, the manifest, backends and catalogs.
SDK and CLIThe npm packages @pithyx/sdk, @pithyx/ui and @pithyx/cli.
ReferenceEvery error code, the REST API, the manifest and Compose rules, and a glossary.
ProjectLicense, privacy, contributing, reporting security issues and the changelog.