FilePipe

Install

FilePipe is a software that supports automated file transfer between multiple clusters and nodes, and can run on Windows, Linux, and macOS systems. In this document, we will explain how to install and start FilePipe on Windows, Linux, and macOS systems respectively.

Windows

To install and start FilePipe on Windows, follow these steps:

  1. Download the FilePipe client: You can download the FilePipe client from the official websiteopen in new window. After the download is complete, double-click the file to start the FilePipe client. You will be prompted to modify the configuration file on first startup.

  2. Configure the FilePipe Client: On a Windows system, navigate to the C:\Users\<your username>\Documents\ directory and locate the config.yaml configuration file within the 'filepipe' folder. Alternatively, you can quickly access this file by right-clicking on the taskbar icon in the lower right corner of the screen when the client program is running. In this file, you can adjust some basic settings for the FilePipe client.

  3. Start using FilePipe: Double-click the filepipe-node-win.exe file on Windows to start the client.

Linux

To install and start FilePipe on a Linux system, follow these steps:

  1. Open the terminal: Open the terminal on your Linux system.

  2. Install the FilePipe client: Enter the following command to install the FilePipe client:

$ curl --proto '=https' --tlsv1.2 -sSf https://filepipe.app/api/v1/sh/install.sh | sh
  1. Start the FilePipe client: Enter the following command in the Linux terminal to start the FilePipe client:
$ systemctl start filepipe.service
  1. The first time you start it, you will be prompted to configure the client. The configuration file directory for Linux systems is /etc/filepipe/config.yaml. Open this file to configure it and then restart using the following command:
$ systemctl restart filepipe.service

For specific configuration details, please refer to Config.

  1. Refer to Linux's various commands for more information.
systemctl status filepipe.service  - View status
systemctl stop filepipe.service    - Stop
systemctl start filepipe.service   - Start
systemctl enable filepipe.service  - Enable service to start at boot (similar to startup)
systemctl disable filepipe.service - Disable service from starting at boot (similar to disabling startup)
systemctl restart filepipe.service - Restart

macOS

To install and start FilePipe on macOS, follow these steps:

  1. Open the Terminal: Open the Terminal on your macOS system.

  2. Install FilePipe client: Enter the following command to install the FilePipe client:

$ curl --proto '=https' --tlsv1.2 -sSf https://filepipe.app/api/v1/sh/install.sh | sh
  1. Start FilePipe client: In the installation directory, enter the following command to start the FilePipe client:
$ launchctl start app.filepipe.plist
  1. First-time users will be prompted to create a configuration file. The configuration file directory on macOS is /etc/filepipe/config.yaml. Open this file to configure FilePipe client and restart after saving the changes.

For detailed configuration instructions, please refer to Config.

  1. Commands for macOS:
launchctl load $HOME/Library/LaunchAgents/app.filepipe.plist   Load the process, start and run it.
launchctl start app.filepipe.plist    Start
launchctl stop app.filepipe.plist    Stop
launchctl list View running services

About updates

When there is a new update for the Node client, please follow the instructions based on your operating system.

If you are using Windows, you can download the latest client from the FilePipe homepageopen in new window and replace the old version with it.

If you are a Linux or macOS user, updating the FilePipe client program is the same as installing it. You can execute the following command again to update it:

$ curl --proto '=https' --tlsv1.2 -sSf https://filepipe.app/api/v1/sh/install.sh | sh

About Uninstalling

The steps to uninstall FilePipe vary slightly depending on the operating system you are using. Please follow the instructions below for your operating system.

Windows

  1. First, exit the FilePipe Node client program to ensure it has stopped running.

  2. Find and delete the .exe file for the FilePipe Node client.

  3. Open the following folder: C:\Users\<your-username>\document\filepipe.

  4. Delete all files and folders in that directory.

Linux

  1. First, exit the FilePipe Node client program to ensure it has stopped running.

  2. Open the terminal and navigate to the following folder: /etc/systemd/system/.

  3. Find and delete the filepipe.service file.

  4. Open the following folder: /usr/local/bin/.

  5. Find and delete the filepipe file.

  6. Finally, open the following folder: /etc/filepipe/.

  7. Delete the config.yaml file.

Please note that before deleting these files and folders, back up your data to avoid data loss.

macOS

  1. First, exit the FilePipe Node client program to ensure it has stopped running.

  2. Open the following folder: $HOME/.local/filepipe/bin/.

  3. Delete the filepipe file.

  4. Open the following folder: $HOME/Library/LaunchAgents/.

  5. Delete the app.filepipe.plist file and folder.

  6. Finally, open the following folder: /etc/filepipe/.

  7. Delete the config.yaml file.

We hope this uninstallation guide can help you easily uninstall our software. If you encounter any problems or have any questions while using our software, please feel free to contact our technical support team.