Skip to content

nixos-rclone

A NixOS module and Rust daemon for rclone mounts and two-way sync that pushes local changes in seconds, with Markdown-to-docx conversion built in.

NixOSActiveMIT
View on GitHub (opens in a new tab)
Platform

NixOS

License
MIT
Status
Active

rclone can reach almost any cloud storage, but keeping a local folder in sync with it usually means a cron job and hoping nothing changed on both sides. nixos-rclone turns rclone into declarative NixOS configuration, backed by a small Rust daemon that watches your files and pushes changes the moment they happen. It's for people who want Google Drive, SFTP, or other remotes to behave like a local folder on a NixOS machine.

Features

  • Mounts. Declare FUSE mounts as fileSystems with systemd automount, mounted on first access.

  • Push on change. Created, edited, renamed, and deleted files reach the remote within seconds of the tree going quiet. Remote changes are pulled on a timer.

  • Renames that stick. A local rename becomes a server-side move, so a Google Drive document keeps its file ID, sharing, and history.

  • Markdown and docx. Built-in conversion, without pandoc, lets you edit an Obsidian vault as Google Docs.

  • Safety first. Large bursts of deletions are held back for the pull's checks, and a sync that locks itself out waits for you instead of resyncing blindly.

  • Status and control through the rclone-remotes command, plus recovery after suspend and resume.

Getting started

Add the flake as an input, import nixosModules.default, and declare your remotes. The README has a complete configuration example and an options reference, including upgrade notes from the older script-based module.

Related projects

All open-source projects

Reproducible Nix infrastructure for Frappe and ERPNext, from the development shell to OCI containers and a multi-site NixOS module.

odoo-nix

Active

Reproducible Nix infrastructure for Odoo Community (OCB) and OCA projects, from scaffolding and development to containers and NixOS.

A fast FrankenPHP WordPress stack built with Nix, deployable as OCI containers or a NixOS module, with MySQL, Cloudflare D1, or Turso databases.

Need help with it?

Need this implemented? We set up file sync and backups as part of managed infrastructure.