[{"data":1,"prerenderedAt":390},["ShallowReactive",2],{"navigation":3,"\u002Fgetting-started\u002Frequirements":94,"\u002Fgetting-started\u002Frequirements-surround":385},[4,16,38,56,70,80],{"title":5,"path":6,"stem":7,"children":8,"icon":15},"Getting Started","\u002Fgetting-started","1.getting-started\u002F1.index",[9,11],{"title":10,"path":6,"stem":7},"What is fsbackup?",{"title":12,"path":13,"stem":14},"Requirements & hardware","\u002Fgetting-started\u002Frequirements","1.getting-started\u002F2.requirements","i-lucide-rocket",{"title":17,"icon":18,"path":19,"stem":20,"children":21,"page":37},"Installation","i-lucide-package","\u002Finstallation","2.installation",[22,26,30,33],{"title":23,"path":24,"stem":25},"Quick start","\u002Finstallation\u002Fquickstart","2.installation\u002F1.quickstart",{"title":27,"path":28,"stem":29},"ZFS pool setup","\u002Finstallation\u002Fzfs-pool","2.installation\u002F2.zfs-pool",{"title":17,"path":31,"stem":32},"\u002Finstallation\u002Fbare-metal","2.installation\u002F3.bare-metal",{"title":34,"path":35,"stem":36},"Adding remote hosts","\u002Finstallation\u002Fadding-hosts","2.installation\u002F4.adding-hosts",false,{"title":39,"icon":40,"path":41,"stem":42,"children":43,"page":37},"Configuration","i-lucide-sliders","\u002Fconfiguration","3.configuration",[44,48,52],{"title":45,"path":46,"stem":47},"fsbackup.conf","\u002Fconfiguration\u002Ffsbackup-conf","3.configuration\u002F1.fsbackup-conf",{"title":49,"path":50,"stem":51},"targets.yml","\u002Fconfiguration\u002Ftargets","3.configuration\u002F2.targets",{"title":53,"path":54,"stem":55},"Scheduling","\u002Fconfiguration\u002Fscheduling","3.configuration\u002F3.scheduling",{"title":57,"icon":58,"path":59,"stem":60,"children":61,"page":37},"Usage","i-lucide-play","\u002Fusage","4.usage",[62,66],{"title":63,"path":64,"stem":65},"Web UI","\u002Fusage\u002Fweb-ui","4.usage\u002F1.web-ui",{"title":67,"path":68,"stem":69},"Running jobs manually","\u002Fusage\u002Frunning-jobs","4.usage\u002F2.running-jobs",{"title":71,"icon":72,"path":73,"stem":74,"children":75,"page":37},"Restore","i-lucide-history","\u002Frestore","5.restore",[76],{"title":77,"path":78,"stem":79},"Restoring data","\u002Frestore\u002Frestore","5.restore\u002F1.restore",{"title":81,"icon":82,"path":83,"stem":84,"children":85,"page":37},"Reference","i-lucide-book-open","\u002Freference","6.reference",[86,90],{"title":87,"path":88,"stem":89},"Script reference","\u002Freference\u002Fscripts","6.reference\u002F1.scripts",{"title":91,"path":92,"stem":93},"Prometheus metrics","\u002Freference\u002Fmetrics","6.reference\u002F2.metrics",{"id":95,"title":12,"body":96,"description":378,"extension":379,"links":380,"meta":381,"navigation":382,"path":13,"seo":383,"stem":14,"__hash__":384},"docs\u002F1.getting-started\u002F2.requirements.md",{"type":97,"value":98,"toc":368},"minimark",[99,104,173,177,181,186,189,193,201,268,273,284,287,297,301,321,325,328,331,335,338,364],[100,101,103],"h2",{"id":102},"software","Software",[105,106,107,120],"table",{},[108,109,110],"thead",{},[111,112,113,117],"tr",{},[114,115,116],"th",{},"Requirement",[114,118,119],{},"Notes",[121,122,123,132,145,153,165],"tbody",{},[111,124,125,129],{},[126,127,128],"td",{},"Linux (Ubuntu 22.04+ \u002F Debian 12+)",[126,130,131],{},"The backup server host OS",[111,133,134,137],{},[126,135,136],{},"ZFS (OpenZFS)",[126,138,139,140,144],{},"For snapshot storage — ",[141,142,143],"code",{},"zfsutils-linux"," package",[111,146,147,150],{},[126,148,149],{},"rsync on remote hosts",[126,151,152],{},"Version 3.x recommended",[111,154,155,158],{},[126,156,157],{},"SSH access to remote hosts",[126,159,160,161,164],{},"fsbackup pulls via ",[141,162,163],{},"backup"," user over SSH",[111,166,167,170],{},[126,168,169],{},"node_exporter (optional)",[126,171,172],{},"For Prometheus metrics",[100,174,176],{"id":175},"backup-server-hardware","Backup server hardware",[178,179,180],"p",{},"fsbackup is designed to run on a dedicated backup server — a machine that exists solely to pull and store backups from other hosts on your network.",[182,183,185],"h3",{"id":184},"cpu-and-ram","CPU and RAM",[178,187,188],{},"fsbackup is not CPU or RAM intensive. A modest machine (2+ cores, 4 GB RAM) is more than sufficient. The bottleneck is almost always disk or network I\u002FO. ZFS ARC will use available RAM for read caching — more RAM helps with frequent restores.",[182,190,192],{"id":191},"storage-zfs-pool","Storage — ZFS pool",[178,194,195,196,200],{},"All snapshots are stored on a ZFS pool. The recommended topology for a two-disk setup is a ",[197,198,199],"strong",{},"mirrored vdev",": both disks hold identical data, and a single disk failure is fully survivable.",[202,203,208],"pre",{"className":204,"code":205,"language":206,"meta":207,"style":207},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","# Create a mirrored pool on two disks\nsudo zpool create -o ashift=12 backup mirror \u002Fdev\u002Fsdc \u002Fdev\u002Fsdf\nsudo zfs create backup\u002Fsnapshots\n","bash","",[141,209,210,219,255],{"__ignoreMap":207},[211,212,215],"span",{"class":213,"line":214},"line",1,[211,216,218],{"class":217},"sHwdD","# Create a mirrored pool on two disks\n",[211,220,222,226,230,233,236,239,243,246,249,252],{"class":213,"line":221},2,[211,223,225],{"class":224},"sBMFI","sudo",[211,227,229],{"class":228},"sfazB"," zpool",[211,231,232],{"class":228}," create",[211,234,235],{"class":228}," -o",[211,237,238],{"class":228}," ashift=",[211,240,242],{"class":241},"sbssI","12",[211,244,245],{"class":228}," backup",[211,247,248],{"class":228}," mirror",[211,250,251],{"class":228}," \u002Fdev\u002Fsdc",[211,253,254],{"class":228}," \u002Fdev\u002Fsdf\n",[211,256,258,260,263,265],{"class":213,"line":257},3,[211,259,225],{"class":224},[211,261,262],{"class":228}," zfs",[211,264,232],{"class":228},[211,266,267],{"class":228}," backup\u002Fsnapshots\n",[178,269,270],{},[197,271,272],{},"CMR (Conventional Magnetic Recording) drives are strongly recommended.",[274,275,278],"u-callout",{"color":276,"icon":277},"orange","i-lucide-alert-triangle",[178,279,280,283],{},[197,281,282],{},"Avoid SMR drives for ZFS."," SMR (Shingled Magnetic Recording) drives use a write-cache that causes severe performance degradation under ZFS's random-write workload, especially during resilver and scrub operations. This can cause jobs that should take minutes to run for hours.",[178,285,286],{},"Recommended drives:",[288,289,290,294],"ul",{},[291,292,293],"li",{},"NAS-rated CMR drives (Seagate IronWolf, WD Red Plus\u002FPro)",[291,295,296],{},"Any CMR drive 4 TB+ for meaningful retention depth",[182,298,300],{"id":299},"storage-not-recommended","Storage — NOT recommended",[288,302,303,309,315],{},[291,304,305,308],{},[197,306,307],{},"SMR desktop drives"," (Seagate BarraCuda, WD Blue) — avoid for ZFS; acceptable for archival\u002Fsequential use only",[291,310,311,314],{},[197,312,313],{},"USB drives"," — too slow and unreliable for regular rsync + ZFS workloads",[291,316,317,320],{},[197,318,319],{},"Network shares (NFS\u002FSMB)"," — not supported as ZFS storage",[100,322,324],{"id":323},"network","Network",[178,326,327],{},"fsbackup pulls from remote hosts over SSH. All remote hosts must be reachable from the backup server on port 22 (or a configured alternative).",[178,329,330],{},"For home lab setups spanning multiple VLANs, ensure routing between the backup server's VLAN and the target hosts' VLANs is configured correctly.",[100,332,334],{"id":333},"unsupported-configurations","Unsupported configurations",[178,336,337],{},"The following are not currently supported:",[288,339,340,346,352,358],{},[291,341,342,345],{},[197,343,344],{},"Windows hosts as backup targets"," — fsbackup uses rsync over SSH; WSL2 can work but is not tested",[291,347,348,351],{},[197,349,350],{},"Pushing backups"," (agent on source host pushes to fsbackup) — fsbackup is pull-only",[291,353,354,357],{},[197,355,356],{},"Non-ZFS snapshot storage"," — v2.0 requires ZFS; the old hard-link snapshot model is no longer supported",[291,359,360,363],{},[197,361,362],{},"Incremental S3 sync"," — S3 export is a full snapshot upload per tier\u002Ftarget; no block-level deduplication",[365,366,367],"style",{},"html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":207,"searchDepth":214,"depth":221,"links":369},[370,371,376,377],{"id":102,"depth":221,"text":103},{"id":175,"depth":221,"text":176,"children":372},[373,374,375],{"id":184,"depth":257,"text":185},{"id":191,"depth":257,"text":192},{"id":299,"depth":257,"text":300},{"id":323,"depth":221,"text":324},{"id":333,"depth":221,"text":334},"What you need to run fsbackup — software prerequisites, disk recommendations, and unsupported configurations.","md",null,{},true,{"title":12,"description":378},"NMicUFxBi0i-F5-MjKF9DT1eTjGnkTNFK5ArZfMVDNw",[386,388],{"title":10,"path":6,"stem":7,"description":387,"children":-1},"An overview of fsbackup — what it does, how it works, and what it's designed for.",{"title":23,"path":24,"stem":25,"description":389,"children":-1},"Get fsbackup running in under 20 minutes with the automated installer.",1775923865773]