Install with Python (pip)

Install ThingsBoard IoT Gateway as a Python package using pip on Ubuntu or Debian-based systems.

• Python 3.10 or higher is installed.
• sudo access on the target machine.

1. Install required system libraries and the venv module.

   sudo apt update
   sudo apt install -y python3-dev python3-pip python3-venv libglib2.0-dev wget

2. Create and activate a virtual environment.

   python3 -m venv ~/tb-gateway-env
   source ~/tb-gateway-env/bin/activate

3. Install ThingsBoard Gateway inside the virtual environment.

   pip install --upgrade pip
   pip install thingsboard-gateway

4. Download and unpack the example configuration.

   wget https://github.com/thingsboard/thingsboard-gateway/releases/latest/download/configs.tar.gz
   sudo mkdir /etc/thingsboard-gateway
   sudo mkdir /var/log/thingsboard-gateway
   sudo tar -xvzf configs.tar.gz -C /etc/thingsboard-gateway

5. Set folder permissions. Replace YOUR_USER with the user that will run the Gateway.

   sudo chown YOUR_USER:YOUR_USER -R /var/log/thingsboard-gateway
   sudo chown YOUR_USER:YOUR_USER -R /etc/thingsboard-gateway

6. Create a Gateway device in ThingsBoard.

   Go to Entities > Gateways and click the + icon in the upper-right corner. Enter a name (e.g., My Gateway), select the default device profile, and click Create.

   Go to Entities > Gateways and click the + icon to add a new gateway. Enter a gateway name, select the default device profile, and click Create.

7. Configure the Gateway credentials.

   Click the General configuration button on the Gateway device page and copy the Access token from the General tab. Then open the Gateway configuration file and paste the token, replacing the host and port with your ThingsBoard instance address:

   nano /etc/thingsboard-gateway/config/tb_gateway.json

   Click the General configuration button. Copy the Access token from the General tab. Paste the access token and update the host and port. Save with Ctrl+O, exit with Ctrl+X.

8. Configure the log file path.

   Click General configuration again, navigate to the Logs tab, and set the File path to /var/log/thingsboard-gateway for each entry in the Local logging section. Click Save.

   Click the General configuration button. Set the file path to /var/log/thingsboard-gateway for all Local logging entries, then click Save.

9. Start the Gateway and verify.

   thingsboard-gateway

   If everything is configured correctly, the Gateway device status changes to Active in ThingsBoard.