Documentation downloads & feeds

Every page in this documentation is available as a single combined document for offline reading, printing, and AI coding assistants, and each page publishes an RSS feed so you can follow changes without polling the site.

Current release - v0.3.10

Generated from the same Markdown the site renders, at the version the product is on.

Format	Download	Size	Best for
Markdown	swarmfile-docs-0.3.10.md	-	AI coding assistants, agents, and anything that reads plain text.
PDF	swarmfile-docs-0.3.10.pdf	-	Saving, printing, and distributing to people who want the whole manual in one file.

Use the docs in your AI tools

Working with an AI assistant? Point it at /llms.txt for a curated index of the site, or hand it the combined Markdown above for the full text in one file. Coding agents can connect to the read-only documentation MCP server at https://swarmfile.com/mcp, which exposes search_swarmfile_docs, read_swarmfile_docs and get_swarmfile_docs_index over this same documentation.

Stable URLs for tools, scripts and bookmarks: /docs-export/latest.md and /llms-full.txt always serve the current Markdown, and /docs-export/latest.pdf the current PDF. Each version keeps one stable URL; if a release's docs are re-exported, that URL is updated in place, the table’s updated date moves, and the bundle feed records a new revision.

Version history

Every release publishes its own versioned copy of both documents, so you can match the documentation to the client version you run and still find older editions later. The list below is published by the release pipeline alongside the artifacts; see the changelog for what changed in each release.

Loading version history…

RSS feeds

Each feed is a lightweight change notification: it carries the page title, a link, and the revision date - never the page body. A page that changes gets a new revision, so your reader flags it as new; a page that hasn’t changed is never re-announced just because the site rebuilt.

Documentation releases (RSS) - one item per published bundle version, plus a new item whenever the bundle changes within a version, with links to the versioned Markdown and PDF.
All page feeds (OPML) - import this into your feed reader to subscribe to the bundle feed and every page below at once.

Or subscribe per section:

Guides (31 feeds)

Getting Started - Install the client, sign in, and mount your first project.
Coming from Git - Map your Git habits onto Swarmfile - the command cheat sheet, and the few places the model genuinely differs.
Moving from Perforce - Map depots, streams, changelists, and p4 edit onto Swarmfile - and import your head revision honestly, without a history importer.
Migrating Existing Data - Move an existing NAS, S3 bucket, or file list into Swarmfile.
Deployment Topologies - Central, LAN-first, or seeded from your NAS - the same product, shown side by side.
Working with Files - Browsing, opening and saving, locking, and who's-editing presence.
Working Offline (Pack & Go) - Download a scope for reading, reserve one for editing with Pack & Go, and land your changes cleanly when you're back online.
Multiple Mounts - Open a second project or branch as its own drive, target commands at one mount, and close it cleanly.
File Previews - Thumbnails, inline preview, video posters and scrubbable proxies, and point-cloud previews in the dashboard.
Search - Find files fast from the dashboard omnibox, the Desktop App, or the CLI.
Notifications & Inbox - The notification bell, Desktop App toasts, and email preferences with per-kind toggles and quiet hours.
Sync Exclusions - Keep node_modules, build output, and other local-only files off the hub with .gitignore and .swarmfileignore.
Performance & Disk Usage - How the local cache works, how reads get fast over LAN and seeds, bandwidth scheduling, and getting disk space back.
Version Control - Commits, changelists, and restoring a file, folder, or project to a past point in time.
Branches & Merging - Work a look-dev variant or design option in isolation, then merge it back.
Trash, History & Rollback - Recover a deleted file or roll back a change.
Verifiable History - Hash-chained commits and hub-signed checkpoints: what they prove, and how to check a project's history yourself.
Git and Swarmfile - Where Swarmfile's version control - more flexible than Git for large projects - meets Git, and how to adopt it self-serve without leaving Git: the git-LFS server, git clone, repo import, and the CLI's git-style commands.
Cloning a Project with Git - Turn on git access for a project, git clone swarmfile://org/project, fetch new commits, push commits back, and what a clone does and doesn't contain.
Git-LFS - Keep your source in the git host you use and offload the big files to Swarmfile as a git-LFS server - setup, credentials, and dedup with the mounted drive.
Coding Agents - One mounted workspace per agent: a headless engine and project API key, a labeled mount per agent, a shared dependency cache, and the durable create queue.
Runner (Headless CI) - A headless engine that watches a branch and runs a job on commit or tag - no separate clone; the branch is materialized from the project's blocks.
Hosted CI - Run .swarmfile/ci.yml workflows on Swarmfile's containers: enable it per project, write jobs, use secrets, pick a runner size, read logs, and understand the per-second billing.
Automating Swarmfile - The supported automation surfaces: which credential to use (project API key vs personal access token), headless engines, scriptable CLI recipes, CI check reporting, and signed webhooks.
Sharing & Collaboration - Comments, watch notifications, share links, and external collaborators.
Worksharing (no plugin) - Revit/SolidWorks-class worksharing enforced across machines - Swarmfile honors the native OS exclusive-open lock, with no add-in and no lock server.
RFIs & Submittals - Numbered, auditable review workflows over your files - questions answered, documents stamped, with a decision of record.
Public Projects & Org Profiles - Publish a release for anyone to browse, and set up your organization's public page, README, followers, and releases feed.
Publishing Releases - Publish a tag of a public project as a release: archives, commit pinning, Explore, followers and feeds, and forking a release into your own org.
Troubleshooting - The drive won't mount, a file won't open, sync is stuck - where to look first, and what to attach when you ask for help.
Uninstall & Clean Reinstall - Remove Swarmfile from a machine without losing queued work, and start fresh when you need to.

Admin & IT (18 feeds)

Organizations, Projects & Members - Structure, invites, roles, and archiving.
Identity - Bring your own SSO (OIDC), SAML on Enterprise via an adapter, SCIM provisioning, on-prem LDAP sync, and an org-wide MFA/verified-email policy.
LDAP Directory Sync - Run the customer-hosted agent that syncs Active Directory users and groups into your org.
Permissions - Folder and file ACLs, protected-mode projects, and Windows DACL projection.
Self-Hosted Seed Nodes - Run a NAS or on-prem machine as a warm tier for your office.
Security - Encryption, erasure coding, ransomware detection, and the E2E-encryption tier.
Security Architecture (Whitepaper) - The vendor-review deep dive: threat model, who-can-decrypt matrix, key custody, and where each guarantee's limits are.
Trust & Compliance - Compliance posture, subprocessors, data-lifecycle commitments, and where to start a security review.
End-to-End Encryption Setup - Turning on the E2E tier, the org recovery key and Shamir shares, enrollment, and recovery.
Dedicated Storage Isolation - Where an org's bytes physically live - shared, its own dedicated bucket (the default for paid orgs), or a customer-supplied one - plus the public-access switches for a BYOS bucket.
Bring Your Own Storage - Enterprise: make an S3-compatible bucket on your own account the org's primary block storage.
Data Residency - Pin an org's metadata and block storage to a real, infrastructure-enforced jurisdiction - EU or US, free on every paid plan; FedRAMP regions are Enterprise, provisioned through sales.
Billing & Plans - Plans, usage, overage, and the self-serve billing portal.
Operations - Audit log, retention & GC, and connectivity diagnostics.
Webhooks - Signed HTTP callbacks for org and personal events - setup, signature verification, retries, and auto-disable.
Deploying to Your Team - Silent install, GPO/MDM push, and what a freshly-provisioned machine needs before someone signs in.
Data Portability & Offboarding - Getting your data out, what happens on cancellation or downgrade, and what uninstalling actually removes.
Branch Mirror to S3 - Continuously export a branch's real files to a bucket you control - for hand-off, backup, or feeding a pipeline.

Reference (10 feeds)

Filesystem Compatibility & Conformance - What POSIX/WinFsp semantics are actually verified per platform, and what's a declared gap.
Supported Platforms & System Requirements - OS versions, architectures, what each installer bundles, disk expectations, and file-size limits.
Release Channels & Updates - Where installs come from, how updates are delivered and verified, and how to reinstall cleanly.
Diagnostics & Error Reference - Doctor checks, health endpoints, status counters, and what each error code means and what to do.
Environment Variable Index - Every SWARMFILE_* variable, its default, and whether it can live in config.json instead.
Engine Config File (config.json) - Every config.json key, its env-var override and default, and how to hand-edit it for headless nodes.
Network Requirements - Every port, protocol, and host Swarmfile talks to, for firewall allowlisting before rollout.
Storage Format - How file bytes are stored - chunking, CIDs, manifests, encryption, erasure coding, bucket layout - and how to reconstruct a file by hand.
Telemetry & Data Collection - What the client reports, what is metered server-side, and what each third party can and cannot see.
Known Limitations - What's deliberately not built or works differently - engine plugins, Perforce history, git rebase, E2E with git-LFS, fixed encryption tiers, and more.

CLI Reference (10 feeds)

swarmfile - The primary CLI - version control, day-to-day mount operations.
swarmfile-doctor - Standalone connectivity diagnostics, no running engine required.
swarmfile-migrate - Bulk-import an existing directory, file list, or S3 bucket.
swarmfile-search - Full-text search from the command line.
swarmfile-seed - One-shot: seed a single local file into the hub.
swarmfile-brlock - Byte-range lock test client, for native-app plugin developers.
swarmfile-runner - Run the engine headless in runner mode (CI), no FUSE.
swarmfile-verify-history - Verify a project's signed commit chain against the hub.
swarmfile-lfs-transfer - git-LFS custom transfer agent (spawned by git-lfs).
git-remote-swarmfile - The git remote helper behind swarmfile:// clone, fetch and push.