# FaynoSync - Auto-Updater Service

> FaynoSync is a self-hosted, open-source auto-updater service for desktop and cross-platform applications (Electron, Tauri, Squirrel), with multi-cloud distribution, telemetry, and secure delivery.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [API Reference](https://faynosync.com/docs/api.md): Complete FaynoSync API documentation with all endpoints, parameters, and examples
- [Application Management](https://faynosync.com/docs/api/apps/app-introduction.md): Complete guide to managing applications in FaynoSync API with CRUD operations
- [Create Application](https://faynosync.com/docs/api/apps/create.md): Create a new FaynoSync application record with metadata, visibility settings, and authenticated API access.
- [Delete artifact](https://faynosync.com/docs/api/apps/delete-specific-artifact.md): Delete a specific FaynoSync application artifact by version, platform, architecture, and package type.
- [Delete specific version of application](https://faynosync.com/docs/api/apps/delete-specific-version-app.md): Delete a specific FaynoSync application version and its related release metadata from the API.
- [Delete Specific application](https://faynosync.com/docs/api/apps/delete.md): Delete a FaynoSync application by identifier and remove its associated application metadata.
- [Download artifact from private bucket](https://faynosync.com/docs/api/apps/download.md): Download a private FaynoSync application artifact through authenticated API access and signed storage URLs.
- [Get All Applications (deprecated)](https://faynosync.com/docs/api/apps/get-all.md): Deprecated FaynoSync endpoint for retrieving all applications with versions and artifacts. Use the app list endpoint instead.
- [List Applications](https://faynosync.com/docs/api/apps/list-apps.md): List FaynoSync applications with concise metadata for dashboards, automation, and API clients.
- [Search application by name](https://faynosync.com/docs/api/apps/search.md): Search FaynoSync applications by name and retrieve matching application metadata through the API.
- [Update application](https://faynosync.com/docs/api/apps/update-app.md): Update FaynoSync application metadata such as name, logo, description, and related settings.
- [Update specific version of application](https://faynosync.com/docs/api/apps/update-specific-version-app.md): Update metadata for a specific FaynoSync application version, including publish state and release details.
- [Upload App](https://faynosync.com/docs/api/apps/upload.md): Upload FaynoSync application artifacts with version, channel, platform, architecture, and package metadata.
- [Architecture Management](https://faynosync.com/docs/api/archs/arch-introduction.md): Complete guide to managing deployment architectures in FaynoSync API including AMD64, ARM64, and custom architectures
- [Create arch](https://faynosync.com/docs/api/archs/create.md): Create a deployment architecture entry in FaynoSync for artifact targeting and update distribution.
- [Delete Specific Arch](https://faynosync.com/docs/api/archs/delete.md): Delete a specific FaynoSync architecture entry from the deployment architecture catalog.
- [Get All Architectures](https://faynosync.com/docs/api/archs/get.md): Retrieve all FaynoSync architecture entries available for application artifact targeting.
- [Update Arch](https://faynosync.com/docs/api/archs/update.md): Update a FaynoSync architecture name or configuration used for artifact targeting.
- [Authentication Management](https://faynosync.com/docs/api/auth/auth-introduction.md): Complete guide to FaynoSync authentication API with login, signup, and JWT tokens
- [Login](https://faynosync.com/docs/api/auth/login.md): Authenticate with the FaynoSync API and receive a JWT token for protected API requests.
- [SignUp](https://faynosync.com/docs/api/auth/signup.md): Create a FaynoSync user account through the signup API endpoint with required credentials.
- [Channel Management](https://faynosync.com/docs/api/channels/channel-introduction.md): Complete guide to managing deployment channels in FaynoSync API including nightly, stable, and custom channels
- [Create Channel](https://faynosync.com/docs/api/channels/create.md): Create a FaynoSync release channel for distributing application versions to specific audiences.
- [Delete Specific Channel](https://faynosync.com/docs/api/channels/delete.md): Delete a specific FaynoSync release channel from the channel catalog.
- [Get All Channels](https://faynosync.com/docs/api/channels/get.md): Retrieve all FaynoSync release channels available for application version distribution.
- [Update Channel](https://faynosync.com/docs/api/channels/update.md): Update a FaynoSync release channel name or configuration used for version distribution.
- [Fetch Latest Version of App](https://faynosync.com/docs/api/info/fetch-latest-build.md): Fetch the latest available FaynoSync application build for a channel, platform, architecture, and updater type.
- [Health Check](https://faynosync.com/docs/api/info/health.md): Check FaynoSync API health status for uptime monitoring, readiness checks, and service diagnostics.
- [Status API](https://faynosync.com/docs/api/info/info-introduction.md): FaynoSync status and information endpoints for health checks and service monitoring
- [Check Latest Version](https://faynosync.com/docs/api/info/latest.md): Check the latest FaynoSync application version and update metadata for supported client update flows.
- [Squirrel Windows Update](https://faynosync.com/docs/api/info/squirrel-windows.md): Serve Squirrel Windows update metadata and packages for FaynoSync-managed desktop applications.
- [Telemetry beacon](https://faynosync.com/docs/api/info/telemetry_beacon.md): Record client update telemetry without calling checkVersion, optimized for SDK and edge-based flows.
- [Velopack Feed](https://faynosync.com/docs/api/info/velopack-feed.md): Serve the dynamic Velopack releases feed from FaynoSync — returns releases.{channel}.json honoring required intermediate builds per client version.
- [WhoamI](https://faynosync.com/docs/api/info/whoami.md): Retrieve information about the currently authenticated FaynoSync user and active API session.
- [Create Platform](https://faynosync.com/docs/api/platforms/create.md): Create a FaynoSync platform entry with updater configuration for targeted application releases.
- [Delete Specific Platform](https://faynosync.com/docs/api/platforms/delete.md): Delete a specific FaynoSync platform entry from the deployment platform catalog.
- [Get All Platforms](https://faynosync.com/docs/api/platforms/get.md): Retrieve all FaynoSync platform entries and updater configurations available for artifact targeting.
- [Platform Management](https://faynosync.com/docs/api/platforms/platform-introduction.md): Complete guide to managing deployment platforms in FaynoSync API including Linux, Darwin, and custom platforms
- [Update Platform](https://faynosync.com/docs/api/platforms/update.md): Update a FaynoSync platform name and updater configuration, including manual, Velopack, Sparkle, Squirrel, Electron Builder, and Tauri updater types.
- [Delete Report Group](https://faynosync.com/docs/api/reports/delete-group.md): Permanently delete a FaynoSync report group along with its detail blob metadata and the underlying private-bucket storage objects.
- [Ingest Report](https://faynosync.com/docs/api/reports/ingest.md): Public FaynoSync endpoint for clients to submit update, install, crash, and runtime failure reports authenticated by a per-app report key.
- [List Group Detail Blobs](https://faynosync.com/docs/api/reports/list-detail-blobs.md): Retrieve metadata and short-lived presigned download URLs for the stored debug detail blobs of a FaynoSync report group.
- [List Report Groups](https://faynosync.com/docs/api/reports/list-groups.md): Retrieve aggregated FaynoSync report groups filtered by app, version, channel, platform, arch, event type, reason, and time range.
- [Reports Management](https://faynosync.com/docs/api/reports/reports-introduction.md): Complete guide to FaynoSync report ingestion API for collecting and aggregating client update, install, and runtime failure reports.
- [Update Report Group](https://faynosync.com/docs/api/reports/update-group.md): Partially update a FaynoSync report group's lifecycle status, tags, and note for triage — resolve, mute, or reopen aggregated failure groups.
- [Create User](https://faynosync.com/docs/api/team/create.md): Create a FaynoSync team user with credentials and application access permissions.
- [Delete Specific User](https://faynosync.com/docs/api/team/delete.md): Delete a specific FaynoSync team user and remove their access to managed applications.
- [List Users](https://faynosync.com/docs/api/team/list.md): List FaynoSync team users and their application access permissions for administration workflows.
- [Update User](https://faynosync.com/docs/api/team/update.md): Update a FaynoSync team user account, credentials, or application access permissions.
- [Update Admin User](https://faynosync.com/docs/api/team/updateAdmin.md): Update the FaynoSync admin user account settings and credentials through the API.
- [Users Management](https://faynosync.com/docs/api/team/users-introduction.md): Complete guide to FaynoSync team-based user management with granular permissions and access control
- [Create Token](https://faynosync.com/docs/api/tokens/create.md): Create a scoped FaynoSync automation token for authenticated uploads and API workflows.
- [Delete Token](https://faynosync.com/docs/api/tokens/delete.md): Delete a FaynoSync automation token to revoke scoped API access.
- [List Tokens](https://faynosync.com/docs/api/tokens/list.md): List FaynoSync automation tokens and inspect scoped access for upload workflows.
- [CI/CD Token Management](https://faynosync.com/docs/api/tokens/tokens-introduction.md): Personal access tokens for upload automation with scoped application access
- [Check Bootstrap](https://faynosync.com/docs/api/tuf/check_bootstrap.md): Check FaynoSync TUF bootstrap status for an application before publishing trusted update metadata.
- [Check Task](https://faynosync.com/docs/api/tuf/check_tasks.md): Check background FaynoSync TUF task status for bootstrap, signing, publishing, and metadata operations.
- [Delete Artifact (TUF)](https://faynosync.com/docs/api/tuf/delete_artifact.md): Delete a TUF-managed FaynoSync artifact and update trusted metadata for secure clients.
- [Delete Unsigned Metadata](https://faynosync.com/docs/api/tuf/delete_unsigned_metadata.md): Delete pending unsigned FaynoSync TUF root metadata drafts from the signing workflow.
- [Force Metadata Update](https://faynosync.com/docs/api/tuf/force_metadata_update.md): Force regeneration and signing of FaynoSync TUF snapshot, timestamp, and optional online targets metadata.
- [Get Config](https://faynosync.com/docs/api/tuf/get_config.md): Retrieve FaynoSync TUF repository configuration, including key counts, thresholds, and metadata expiration settings.
- [Get Current Delegated Metadata](https://faynosync.com/docs/api/tuf/get_current_delegated_metadata.md): Retrieve the current trusted FaynoSync TUF delegated targets metadata for a delegated role.
- [Get Current Root Metadata](https://faynosync.com/docs/api/tuf/get_current_root_metadata.md): Retrieve the current trusted FaynoSync TUF root metadata for inspection, verification, and rotation planning.
- [Get Current Targets Metadata](https://faynosync.com/docs/api/tuf/get_current_targets_metadata.md): Retrieve the current trusted FaynoSync TUF targets metadata for inspection and delegated role planning.
- [Get Unsigned Root Metadata](https://faynosync.com/docs/api/tuf/get_unsigned_root_metadata.md): Retrieve pending unsigned FaynoSync TUF root metadata and the current trusted root for signature collection.
- [Metadata Rotation](https://faynosync.com/docs/api/tuf/metadata_rotation.md): Rotate FaynoSync TUF root metadata with threshold signatures and publish a new trusted root.
- [Stage Delegated Key Rotation Metadata](https://faynosync.com/docs/api/tuf/post_stage_targets_delegated_metadata.md): Stage delegated targets key rotation metadata for offline signing in FaynoSync TUF flow.
- [Add Signature to Root Metadata](https://faynosync.com/docs/api/tuf/post_unsigned_root_metadata.md): Add a signature to pending FaynoSync TUF root metadata during the threshold signing workflow.
- [Publish Artifacts](https://faynosync.com/docs/api/tuf/publish.md): Sign FaynoSync application artifacts with TUF metadata and publish trusted update metadata for clients.
- [Put Config](https://faynosync.com/docs/api/tuf/put_config.md): Update FaynoSync TUF repository expiration settings for targets, snapshot, and timestamp metadata roles.
- [Bootstrap Recovery](https://faynosync.com/docs/api/tuf/recovery.md): Recover FaynoSync TUF bootstrap state from already published metadata after Redis state loss.
- [Start Bootstrap](https://faynosync.com/docs/api/tuf/start_bootstrap.md): Start FaynoSync TUF repository bootstrap for an application with trusted metadata roles and signing configuration.
- [TUF (The Update Framework) Management](https://faynosync.com/docs/api/tuf/tuf-introduction.md): Complete guide to go-tuf integration in FaynoSync for secure, verifiable application updates
- [CLI](https://faynosync.com/docs/cli.md): faynoSync CLI uploads new application versions to faynoSync in a predictable, CI-friendly way, with a ready-to-use GitHub Action and Jenkins shared...
- [Edge and S3 Response Cache](https://faynosync.com/docs/edge.md): Scale update checks with SDK-driven edge-first delivery, S3-backed response manifests, and telemetry paths designed for high-volume clients.
- [Electron Auto-Update Example](https://faynosync.com/docs/examples/electron.md): Electron auto-update example with faynoSync and electron-updater (generic provider), using the JavaScript SDK for an edge-first update check.
- [Update Example Apps (Electron, Squirrel, Tauri, Velopack, Sparkle)](https://faynosync.com/docs/examples.md): Reference desktop apps integrating faynoSync updates — Electron, Squirrel, Tauri, Velopack, and Sparkle, with edge-first checks and SDK-free options.
- [Sparkle Auto-Update Example (macOS, no SDK)](https://faynosync.com/docs/examples/sparkle.md): Sparkle auto-update example with faynoSync — a native macOS AppKit app updating through the stock Sparkle client, with no SDK required.
- [Squirrel.Mac & Squirrel.Windows Auto-Update Example](https://faynosync.com/docs/examples/squirrel.md): Squirrel.Mac and Squirrel.Windows auto-update example with faynoSync, using the JavaScript SDK resolveNativeFeed for edge-first native update feeds.
- [Tauri Auto-Update Example](https://faynosync.com/docs/examples/tauri.md): Tauri auto-update example with faynoSync — an edge-first update gate via the JavaScript SDK plus tauri-plugin-updater for signature-verified installs.
- [Velopack Auto-Update Example (Python)](https://faynosync.com/docs/examples/velopack.md): Velopack auto-update example with faynoSync — a Python desktop app updating via the stock Velopack client, with TUF verification and telemetry.
- [Docker Development](https://faynosync.com/docs/getting-started/docker-development.md): Run FaynoSync locally with Docker and Docker Compose, including API services, dependencies, and development setup.
- [Environment Variables Overview](https://faynosync.com/docs/getting-started/env-overview.md): Complete guide to FaynoSync environment variables and configuration options
- [Getting Started](https://faynosync.com/docs/getting-started.md): Quick setup guide for FaynoSync auto-updater service - get up and running in minutes
- [Local Deployment](https://faynosync.com/docs/getting-started/local-deploy.md): Quick local deployment of FaynoSync for testing your application updates without cloning repositories or building from source
- [Local Development Setup](https://faynosync.com/docs/getting-started/local-development.md): Complete guide to setting up FaynoSync development environment with MongoDB, Golang, and Garage
- [Logging Configuration](https://faynosync.com/docs/getting-started/logging.md): Complete guide to FaynoSync logging configuration with logrus and different log levels
- [Production Deployment](https://faynosync.com/docs/getting-started/production-deploy.md): Complete guide to deploying FaynoSync in production environment on Linux servers
- [Required Intermediate Build](https://faynosync.com/docs/intermediate_build.md): Learn how to enforce specific update paths in FaynoSync for breaking changes and migrations
- [Introduction to FaynoSync](https://faynosync.com/docs/intro.md): Complete guide to FaynoSync auto-updater service for desktop applications and software distribution
- [Performance Mode](https://faynosync.com/docs/performance.md): Learn how to optimize FaynoSync performance with caching, Redis, and Nginx configuration
- [Staged Rollout](https://faynosync.com/docs/rollout.md): How FaynoSync staged (canary) rollouts work — a server-issued percent and seed, deterministic SDK-side bucketing, and dashboard adoption tracking.
- [Go SDK](https://faynosync.com/docs/sdk/go/sdk.md): Production-oriented Go SDK for checking application updates with faynoSync.
- [SDK Overview](https://faynosync.com/docs/sdk/intro.md): Official faynoSync client SDKs for typed update checks, edge-optimized delivery, and release workflows without changing the core API server.
- [JavaScript SDK](https://faynosync.com/docs/sdk/js/sdk.md): Production-oriented JavaScript/TypeScript SDK for checking application updates with faynoSync.
- [Team Based Authorization](https://faynosync.com/docs/team_based_auth.md): Complete guide to FaynoSync team-based access control and permission management
- [Telemetry System](https://faynosync.com/docs/telemetry.md): Comprehensive guide to FaynoSync telemetry system for analytics and user insights
- [Troubleshooting](https://faynosync.com/docs/troubleshooting.md): Common FaynoSync issues and solutions including CORS configuration and error handling
- [Electron Builder Updater](https://faynosync.com/docs/updaters/electron-builder.md): Serve electron-builder auto-updates from FaynoSync — YAML feed metadata compatible with electron-updater's generic provider.
- [Updaters Support](https://faynosync.com/docs/updaters.md): Complete guide to FaynoSync update mechanisms — Velopack, Sparkle, Squirrel, Electron Builder, Tauri, and manual updates.
- [Manual Updater](https://faynosync.com/docs/updaters/manual.md): The default FaynoSync update flow — standard JSON responses with update_url fields for custom client update logic.
- [Sparkle Updater (macOS)](https://faynosync.com/docs/updaters/sparkle.md): Serve macOS Sparkle auto-updates from FaynoSync — upload a generate_appcast feed and get a per-channel appcast with signatures and deltas preserved.
- [Squirrel (macOS) Updater](https://faynosync.com/docs/updaters/squirrel-darwin.md): Serve Squirrel.Mac auto-updates from FaynoSync — ZIP-only responses tuned for the macOS Squirrel update mechanism.
- [Squirrel (Windows) Updater](https://faynosync.com/docs/updaters/squirrel-windows.md): Serve Squirrel.Windows auto-updates from FaynoSync — URL-based routing and the generated RELEASES manifest.
- [Tauri Updater](https://faynosync.com/docs/updaters/tauri.md): Serve Tauri auto-updates from FaynoSync — signature-verified JSON responses compatible with the Tauri built-in updater.
- [Velopack Updater](https://faynosync.com/docs/updaters/velopack.md): Ship cross-platform desktop auto-updates with Velopack and FaynoSync — native feed protocol, delta updates, CDN delivery, and TUF verification.
- [Self-Hosted API for Automatic App Updates](https://faynosync.com/blog/first-meet-faynosync.md): Meet FaynoSync, an open-source self-hosted update server delivering automatic versioned app updates — no app store bureaucracy, full distribution c...
- [Private Apps in faynoSync — Keep Your Software Secure](https://faynosync.com/blog/private-apps.md): Keep internal tools, beta builds, and enterprise software private in faynoSync — a separate private S3 bucket, gated downloads, and signed URLs.
- [Team-Based Authorization in faynoSync — Manage Your Team Like a Pro](https://faynosync.com/blog/team-based-auth.md): Set up team-based access control in faynoSync — team users, granular per-resource permissions, scoped allowed lists, and fully isolated admin data.
- [Local Development with faynoSync — Choose Your Path](https://faynosync.com/blog/local-development.md): Set up a local FaynoSync development environment two ways — a traditional MongoDB and Go setup, or a Docker-based workflow. Pick the path that fits.
- [Fetch Latest Version of App — Smart Update Links](https://faynosync.com/blog/fetch-latest-version.md): Build download links that always point to the newest release with faynoSync's /apps/latest endpoint — landing pages, OS detection, CI, and Docker.
- [Performance Mode — Speed Up Your API](https://faynosync.com/blog/performance-mode.md): Enable Performance Mode in faynoSync to handle thousands of update checks per minute — a Redis-backed cache plus an optional Nginx microcache layer.
- [How to Setup Auto Update for Electron App](https://faynosync.com/blog/electron-auto-update.md): Add auto updates to your Electron app with faynoSync — custom update flow, native electron-updater integration, code signing, and troubleshooting.
- [Telemetry Insights — Understand Your Users Better 📊](https://faynosync.com/blog/telemetry-insights.md): Track version adoption, platform distribution, and active users with faynoSync's privacy-first telemetry — via checkVersion and a beacon endpoint.
- [Rollout Health Reports — Catch Failed Updates Before They Spread](https://faynosync.com/blog/rollout-health-reports.md): Catch failed updates early with faynoSync report ingestion — clients send update, install, and crash failures, aggregated into rollout-health groups.
- [Scaling Update Checks with Edge + S3 Response Cache](https://faynosync.com/blog/edge-s3-cache.md): Serve repeated update checks from S3 at the edge instead of hitting the API — faynoSync edge-first delivery offloads the hot read path at scale.