Read Files with n8n: Local File Access Guide

n8n is a powerful workflow automation tool that allows you to connect various apps and services to streamline your processes. But what if you need to interact with files on your local system? This blog post will guide you through the process of how to easily read file data and save new files using n8n when it’s self-hosted using docker compose. We’ll explore how to set up your environment and utilize n8n’s file system integration capabilities. So, let’s dive in and learn how to bridge the gap between n8n and your local file system. You can watch the video tutorial here.

Understanding n8n’s Local File Access

When running n8n in a Docker container, direct access to your local file system isn’t possible without specific configurations. Docker containers operate in isolation from the host system. Therefore, we must create a bridge between the two by mapping a specific path on your local machine to a path inside the n8n Docker container. This mapping is crucial for enabling n8n to read file information and write file data to your local computer. Think of it like a shared folder that both systems can access.

Configuring Docker Compose for File Sharing

To set this up, you’ll need to modify your docker-compose.yml file. The key is in the volumes section of your n8n service definition. Here’s an example of what that might look like:

volumes:
  - ./shared:/data/shared

In this example, ./shared refers to a directory named “shared” located in the same directory as your docker-compose.yml file on your host system. This directory is then mapped to /data/shared inside the n8n Docker container. This means that anything you put in your local shared folder will be visible inside the n8n container at the /data/shared path, and vice versa.

“We have to map a specific path in our host system to a specific path inside of the docker container…and that is what we’re doing here on the volumes.”

Saving Files from n8n to your Local System

Now that you have your shared directory set up, you can start writing files from n8n. Let’s say you have a simple JSON object you want to save file as a JSON file on your local system. In n8n, you would first use the Convert to File node to turn the JSON into a file. Then you can utilize the Write File node to save the file. Importantly, you must use the path inside of the Docker container (e.g. `/data/shared/myJSONfile.json`) not the path from your host system.

Here are the steps to follow:

1. Create your JSON data using any node or manually.
2. Add a “Convert to File” node to transform the JSON into a file.
3. Add a “Write File” node.
4. In the “Write File” node settings, set the file path to `/data/shared/yourfilename.json`, and set the file name as desired (e.g., `myJSONfile.json`).
5. Run the workflow, and the file will be created in your host’s “shared” directory.

Remember, the path /data/shared within the n8n container points directly to the shared folder on your host system thanks to the volume mapping we configured. The key is to think of the file path from the perspective of the n8n container.

How to Read Files From Your Local System Into n8n

Now, let’s explore the process of reading file from your local system into n8n. Suppose you have a text file named file.txt in your shared folder with the content “Hi, this is a file.” To read this in n8n we use the Read File node, and like the write file node, we use the container’s mapped path, /data/shared/file.txt to load the file content into the workflow.

Here’s how to do it:

1. Add the Read File node to your n8n workflow.
2. Set the file path to /data/shared/file.txt (or the path to your target file inside the container).
3. Execute the node, and the file’s contents will be available as data for further processing in your workflow.

This process enables you to integrate external data into your automations.

Advanced Use Cases and Considerations

The file interaction capabilities are very flexible. You can use these techniques to process CSV files, text files, or any other file format that n8n can handle. You could, for example, load file data from an external source, transform it using n8n’s powerful nodes and then save file to another location or different format. Also, while this post focuses on n8n local setups, the principle remains the same for a more complex architecture where your n8n instance is run via Docker on a remote server; you are still required to map a volume from the server to the container.

Key Quote: “Whenever we change something inside the docker container here…it will reflect here and vice versa.” This bidirectional syncing makes it easy to manage and monitor files from both the n8n container and the host system.

Conclusion

Integrating n8n with your local file system opens up a world of possibilities for your automation workflows. By utilizing Docker volume mappings and understanding the container’s file path perspective, you can effortlessly read file data and save files to your system. Whether you’re processing data from local files or generating reports, n8n’s file system integration provides the flexibility you need. Be sure to adjust the mapping path to suit your local n8n environment.

Ready to explore more about n8n? Visit the n8n website and start building your automation workflows today! Don’t forget to subscribe to our YouTube channel for more n8n tutorials and tips. Happy automating!