SnapFS docs

SnapFS Documentation

Installing an Agent

Install a SnapFS scanner agent, point it at the right root, and confirm it appears in the console.

Installing an Agent

A SnapFS scanner agent is responsible for walking a filesystem root and publishing scan events.

Before You Install

Make sure you know:

  • the gateway URL (e.g. https://example.snapfs.com)
  • the root path you want this agent to scan (e.g. /mnt/data)
  • API keys (see Managing Access)

Install The Package

The canonical install instructions live in the public snapfsio/snapfs repository:

https://github.com/snapfsio/snapfs

For most Linux hosts, the quick start is:

python3 -m pip install -U snapfs

If you are installing the long-running agent service, follow the install.sh / systemd instructions in the main repo after installing the package:

git clone --depth 1 https://github.com/snapfsio/snapfs
cd snapfs
./systemd/install.sh

Agent Root Paths

Each scanner agent has a configured root path.

Examples:

  • /mnt/projects
  • /data/io

Schedules and manual scans should stay within that root.

Confirm The Agent Is Connected

After installation, open the console and check the Agents page.

You should see:

  • the agent id
  • connection status
  • the configured root path

Agents

If the agent is connected and idle, you are ready to create a schedule.

Next Step

Continue with Creating Schedules.