Skip to main content

Agent

FileFlows Agent connects to an existing FileFlows Server and enables distributed processing.
This allows you to process files on multiple computers, extending the processing capacity beyond the main server.

Installing Homebrew​

If you haven't installed Homebrew yet, install it by running:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Adding the Tap​

Add the FileFlows tap to your Homebrew:

brew tap fileflows/tap

Installing FileFlows Agent​

Install the FileFlows Agent formula:

brew install fileflows-agent

This will install FileFlows Agent as a Brew service which will automatically start on login.

Configuration​

Run the configuration command to set the server URL and the access token:

fileflows-agent --configure

You will be prompted to enter the Server URL.

You can enter an the Access Token.

This creates or updates the agent.config file inside the application data directory.

Access Token

The access token required by the Agent can be found in the web console on the Config > Agents page

Application Directory​

The application data is stored at:

$HOME/Library/Application Support/FileFlowsAgent

Running the Service​

Start the service with:

brew services start fileflows-agent

Stop the service with:

brew services stop fileflows-agent

Restart the service with:

brew services restart fileflows-agent

Running Manually​

You can also run the FileFlows Agent manually by executing:

fileflows-agent

Updating​

To force reinstall the latest version of FileFlows Agent:

brew reinstall fileflows-agent

You may also want to restart the service afterward:

brew services restart fileflows-agent

Updating the Tap​

Fixes to how FileFlows Agent is installed are published in the FileFlows tap. Update the tap with:

brew update

Then reinstall to use the updated tap:

brew reinstall fileflows-agent

If the tap is still out of date, remove it and add it again. --force is needed because FileFlows Agent was installed from the tap, this does not uninstall FileFlows Agent or remove its configuration.

brew untap --force fileflows/tap
brew tap fileflows/tap
brew reinstall fileflows-agent

Failed Changing Dylib ID​

If installing or reinstalling shows an error like:

Error: Failed changing dylib ID of .../libe_sqlite3.dylib
...
Updated load commands do not fit in the header of .../libe_sqlite3.dylib

your FileFlows tap is out of date. Update the tap and reinstall.

Homebrew Cache Issues​

If Homebrew reports that FileFlows Agent is already up to date but you know a newer version exists, this is usually caused by a cache issue.

Run:

brew cleanup --prune=all

Then reinstall:

brew reinstall fileflows-agent

Uninstalling FileFlows Agent​

To uninstall FileFlows Agent:

brew uninstall fileflows-agent

Notes​

  • The launchd service is configured to run as your user (no root required).
  • Configuration must be done once before starting the service.