Quick Start

DataFlux Func is a Python-based script development, management, and execution platform.

DataFlux Func is pronounced as data flux function, and is sometimes abbreviated as DFF within the system.

Download Command for Installation Package

/bin/bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

0. Pre-reading Notes

All shell commands mentioned in this article can be executed directly under the root user. Non-root users need to add sudo to run them.

This article only provides the most common operation steps. For detailed installation and deployment, please refer to Guide / Installation / Single Machine Deployment

1. System Requirements

Ensure that the host or cloud host running DataFlux Func meets the following conditions:

• CPU cores >= 2
• Memory capacity >= 4GB
• Disk space >= 20GB
• Network bandwidth >= 10Mbps
• Operating system is Ubuntu 16.04 LTS / CentOS 7.2 or above （macOS and Windows are not supported）
• Port 8088 is open (the system uses port 8088 by default. Ensure that the firewall, security group, etc., allow inbound access to 8088)

Detailed System Requirements

For more detailed system requirements, please refer to Guide / System Requirements

2. Installation and Deployment

DataFlux Func supports multiple installation package deployment methods. Users can choose according to their actual situation.

Download Installation Package for Deployment

For deployment on a single host, it is recommended to download the installation package for deployment. This method is also suitable for various environments without public network or restricted access.

For Linux, macOS, and other systems, it is recommended to use the official shell command to download the installation package. The script will automatically select the x86_64 or aarch64 architecture version based on the current environment:

/bin/bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

Manual Download of Installation Package

Windows requires manual download of the installation package. Please refer to Guide / Installation / Single Machine Deployment / Manual Download

After downloading, run run-portable.sh in the directory where the installation file is located to automatically configure and finally start the entire DataFlux Func:

sudo /bin/bash {installation file directory}/run-portable.sh

After execution, you can use a browser to access http://{server IP address/domain name}:{port} for the initialization operation interface.

Configuration Parameters of the Installation Script

For the configuration parameters of the installation script, please refer to Guide / Installation / Single Machine Deployment / Installation Options

Install Using Helm in k8s

Please refer to the document Guide / Installation / Helm

3. Initialize the System

After installing DataFlux Func, the first time you access the system, the initialization interface will be displayed. Click the "Save and Initialize Database" button to initialize the database.

Wait a moment, and after the initialization is complete, you will be automatically redirected to the login interface.

4. Run Example Script

The initial installation of DataFlux Func includes a simple code example.

Click the "Edit" button to enter edit mode and modify the code.

In edit mode, you can select the Script to run and click "Run".

The result of the Script execution and the output of print(...) will be displayed in the output bar below.

5. Create Func API

Go to "Manage / Func API" to see the Func API list.

Click "Create" to create a Func API for functions decorated with @DFF.API(...).

6. Call Func API

Go to "Manage / Func API" to see the Func API list.

Click "Example" to display the calling instructions. Adjusting the calling parameters will automatically generate the specific calling method.

Access according to the prompted calling method to get the return value of the function (i.e., the return value)