Overview

This guide walks you through the complete process of installing the Fuuz Device Gateway on a local device, configuring access control, and connecting it to the Fuuz Cloud. It includes steps for downloading the installer, setting up API keys, configuring access policies, and verifying connectivity.

While this KB is in the Cloud to OnPrem section, the Fuuz Gateway also supports onPrem to onPrem integrations using Gateway/Edge Flows.

Before You Begin

• Ensure you have access to your Fuuz Enterprise environment.
• You must have administrator privileges to create users and API keys.
• Each environment (Build, QA, Production) requires its own gateway installation.

Step 1: Download the Gateway Installer

1. Navigate to System > Internet of Things > Fuuz Apps in your Fuuz environment.
2. Locate the appropriate version for your environment (Build, QA, or Production).
3. Download the latest .exe installer file.

Step 2: Create a Gateway User

1. Go to your Administration Tenant.
2. Search for Enterprise Users and click the + icon to create a new user.
3. Use a distribution email (e.g., gateway@yourcompany.com) to receive system alerts.
4. Set Access Type to Gateway Access.
5. Assign the Home Tenant (the tenant the gateway will connect to).
6. Set inactivity timeout and expiration settings as needed.
7. Save the user.

Step 3: Generate an API Key

1. In the Administration Tenant, go to Access Control > API Keys.
2. Click Create and select User API Key.
3. Assign a name, select the tenant, and choose the gateway user you just created.
4. Copy and securely store the API key—it will only be shown once.

Step 4: Configure Access Control Policy

1. Go to the Tenant where the gateway will connect.
2. Navigate to Access Control Policies.
3. Either create a new policy or use an existing one that grants API access.
4. Attach the gateway user to the policy under the Attached Users tab.

Step 5: Install the Gateway on Your Local Device

1. Run the downloaded .exe installer.
2. Accept default settings and choose an installation directory.
3. Complete the installation and start the Fuuz Device Gateway service from your system’s Services panel.
   

Note you can only run 1 instance of the Gateway per Device/Server

Step 6: Log into the Local Gateway

1. Open a browser and go to http://localhost:5500.
2. Enter the API key you created earlier to log in.

Step 7: Install Device Drivers

1. In the local gateway UI, go to the Drivers section.
2. Install the necessary drivers (e.g., MySQL, HTTP, etc.) based on your use case.

Step 8: Add and Configure Devices

1. Go to the Devices section.
2. Click Add Device and select the installed driver.
3. Enter:
   • Device name
   • Password
   • Port
   • Endpoint path or IP address
4. Save the configuration.

Step 9: Verify Cloud Connectivity

1. In the Fuuz Cloud, go to Device Gateways.
2. Locate your newly added gateway and verify the last updated timestamp.
3. Use the Test button to run functions like Get Gateway Status.

Optional: Configure Gateway Settings

Under the Setup tab in the local gateway:

• Set Log Level to Verbose for detailed logs.
• Configure Notification Email (recommended for production).
• Set Log Retention and Sync Interval (e.g., every 10 seconds).

Log Files and Maintenance

• Logs are stored in the installation directory under gateway-service-wrapper.log.
• Configuration files (e.g., wrapper.conf, wrapper.xml) can be edited for advanced settings like custom certificate authorities.
• Use the included uninstaller to remove the gateway if needed.