Configuration

FsPulse supports persistent, user-defined configuration through a file named config.toml. This file allows you to control logging behavior and analysis settings such as thread usage.

Finding `config.toml`

FsPulse uses the directories crate to determine the appropriate location for configuration files and logs based on your operating system. Specifically, FsPulse uses the local data directory (ProjectDirs::data_local_dir()), which resolves to platform-specific standard paths:

Where it's stored:

Platform	Location Description	Example Path
Linux	`$XDG_DATA_HOME`	`/home/alice/.local/share/fspulse`
macOS	Application Support	`/Users/alice/Library/Application Support/fspulse`
Windows	Local AppData	`C:\Users\Alice\AppData\Local\fspulse`

These are all managed internally via the directories crate. On first run, FsPulse will automatically create this directory and write a default config.toml there if one doesn't exist.

Tip: You can delete config.toml at any time to regenerate it with defaults. Newly introduced settings will not automatically be added to an existing file.

Configuration Settings

Here are the current available settings and their default values:

[logging]
fspulse = "info"
lopdf = "error"

[analysis]
threads = 8
hash = "sha2"

Logging

FsPulse uses the Rust log crate, and so does the PDF validation crate lopdf. You can configure logging levels independently for each subsystem in the [logging] section.

Supported log levels:

error – only critical errors
warn – warnings and errors
info – general status messages (default for FsPulse)
debug – verbose output for debugging
trace – extremely detailed logs

Log File Behavior

Logs are written to a logs/ folder inside the same local data directory as config.toml
Each run of FsPulse creates a new log file, named using the current date and time
FsPulse retains up to 100 log files; older files are automatically deleted

Analysis Settings

The [analysis] section controls how many threads are used during the analysis phase of scanning (for hashing and validation).

threads: number of worker threads (default: 8)

You can adjust this based on your system's CPU count or performance needs.

hash: hash function to use when hashing files. Values can be sha2 or md5 (default: sha2)

Sha2 is more secure but is slower. It is appropriate for most users.

New Settings and Restoring Defaults

FsPulse may expand its configuration options over time. When new settings are introduced, they won't automatically appear in your existing config.toml. To take advantage of new options, either:

Manually add new settings to your config file
Delete the file to allow FsPulse to regenerate it with all current defaults