Quick Start Guide

The guide helps you get started with PeakTDM FileFocus.

Install and Start PeakTDM FileFocus

Clone or download this repository. If downloaded as a ZIP, extract the archive to a local folder.

Open a terminal (cmd) and navigate to the repository folder and start the PeakTDM FileFocus environment:

docker compose up -d

If you want to use PeakTDM FileFocus with example files use the following command instead

docker compose --profile examples up -d

or copy your own data files to the ./datafolder in your installation directory.

Your PeakTDM FileFocus instance is now up and running.

Verify the installation

By default PeakTDM FileFocus runs on port 15000.

Copy the following URL into your browser to access the PeakTDM FileFocus Web UI:

👉 http://localhost:15000

Specify your Index Location

You can define a different index location on your computer or in your network. To do so, copy the .env.example file to .env, open it in a text editor.

Set the DATAFOLDER variable to the absolute path of your data files. To apply the configuration settings, restart the PeakTDM FileFocus environment by executing the following commands:

docker compose down -v

and then

docker compose up -d

⚠️ Note: Docker on Windows cannot use UNC paths directly - you need to use the cifs driver for network shares.

Find more details in the basic configuration.

Import Your Own Data Files

PeakTDM FileFocus can deal with almost any measurement file format. In case your file format is not supported yet, you can develop your own ExD data plugin.

👉 Visit the Data Management Learning Path for instructions and examples or contact Peak Solution.

Python API

Access your data programmatically via Python using Peak ASAM ODSBox - a thin wrapper around the PeakTDM FileFocus HTTP(S)-APIs.

👉 Find more Python examples in the Data Management Learning Path