# Install

Several methods are available to install the gateway:

# Install Theengs Gateway as a pip package

Prerequisites:

Command:

pip install TheengsGateway
1

You can access advanced configuration by typing:

python3 -m TheengsGateway -h
1

# Install Theengs Gateway as an Add ON in Home Assistant

  1. Add the Add-on repository into the add-on store

Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled. (opens new window)

Or by going to Settings -> Add-ons -> Add-on store -> ⁞ (Menu) -> Repositories -> Fill in the URL https://github.com/mihsu81/addon-theengsgw -> Add.

  1. You should now see "TheengsGateway HA Add-on" at the bottom list.
  2. Click on "TheengsGateway", then click "Install".
  3. Under the "Configuration" tab, change the settings appropriately (at least MQTT parameters), see Parameters.
  4. Start the Add-on.

# Install Theengs Gateway as a snap

Theengs Gateway is also packaged as a snap in the Snap Store (opens new window). If you have snapd running on your Linux distribution, which is the case by default on Ubuntu, you can install the Theengs Gateway snap as:

Get it from the Snap Store (opens new window)

snap install theengs-gateway
1

Have a look at the Theengs Gateway Snap (opens new window) documentation for more information about how to configure and start Theengs Gateway as a service.

# Install Theengs Gateway as a docker

Theengs Gateway is also available from docker hub thanks to @maretodoric (opens new window)

Docker Image Size (latest by date)
docker pull theengs/gateway
1

# Advanced users - Build and install

Clone the repository and its submodules:

git clone https://github.com/theengs/gateway.git
cd gateway
git submodule update --init --recursive
1
2
3

Change version_tag in setup.py to a valid version string such has 0.6.0 and then build the package:

python3 setup.py sdist
1

After this, enter the dist directory and install the package you built:

cd dist
pip3 install TheengsGateway-<version>.tar.gz
1
2

TIP

When launching the gateway you must be outside of its source code folder to avoid errors