nofus 0.3.0

A daemon for monitoring and reacting to the status of NFS mounts.
nofus-0.3.0 is not a library.

🚀 Nofus - The NFS Mount Guardian

Rust License CI/CD

Nofus is a 🔥 blazingly-fast, 🧠 memory-safe, 🔋 batteries-included, 💺ergonomic, 🦀 100% Rust-powered daemon that vigilantly monitors your NFS mounts and triggers custom actions based on their availability. Never get caught with stale mounts again! 🛡️

✨ Features

  • 🕵️ Real-time NFS Mount Monitoring using Linux inotify
  • ⚡ Configurable System Commands for mount/unmount events
  • 🧪 Dry-Run Mode for safe testing
  • 📊 Verbose Logging for deep insights
  • 🔄 Periodic Health Checks (configurable interval)
  • 📁 YAML Configuration for easy setup

📦 Installation

  1. Prerequisites: If you want to run the project from source, or install from cargo directly. Ensure you have Rust installed (1.60+)

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  2. Install Nofus:

    cargo install nofus

⚙️ Configuration

Create config.yml in your $HOME/.config/nofus directory:

# Sample Configuration
mount_points:
  - "/mnt/nfs/share1"
  - "/media/cloud_storage"

delay_seconds: 5  # Check interval

# Commands to execute (supports full shell syntax)
all_mounted_cmd: "systemctl start my-app.service"
any_unmounted_cmd: "systemctl stop my-app.service && wall 'NFS Crisis!'"

[!TIP] If you start nofus without creating a configuration file first, one will be created from a template and nofus will exit.

🚦 Usage

nofus [OPTIONS]

Options:

  • --dry-run: Simulate without executing commands
  • --verbose: Show debug-level logging

Example:

nofus --verbose --dry-run

🖥️ Sample Workflow

2023-09-15T14:30:00 [INFO] Initial state: All NFS mounts available ✅
2023-09-15T14:35:22 [ERROR] NFS mount disconnected: /mnt/nfs/share1 ❌
2023-09-15T14:35:22 [DEBUG] Executing: systemctl stop my-app.service
2023-09-15T14:36:45 [INFO] Mount recovered: /mnt/nfs/share1 ✅

🤝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feat/amazing-feature)
  5. Open a Pull Request

📜 License

MIT License - see LICENSE for details.