sstarzh / zte-connector

ZTE Connector in a docker container

Ericom/Cradlepoint ZTEdge Connector

Ericom ZTEdge Connector in a docker container zte-client has been integrated into docker environment to allow for easy deployments in Cradlepoint routers.

Docker Hub

NOTE: Not all Cradlepoint models support docker containers. Please refer to specific router documentation to determine if it is compatible with the current project.

The zte-client can be used as a client or as a connector. Cradlepoint routers use connector mode and therefore this guide covers connector mode only.

To pull the container:

docker pull sstarzh/zte-connector:latest

Running in the connector mode:

docker run -ti --cap-add=NET_ADMIN --sysctl="net.ipv4.ip_forward=1" -p 51821:51821 sstarzh/zte-connector:latest <tenant name> <connector name> <key> [<API key>] [<Tenant ID>]

[<API key>] [<Tenant ID>] OPTIONAL parameters to be supplied if public IP update is required. In most cases this is applicable to containers running on Cradlepoint devices that use cellular connectivity and therefore do not have a static IP address.

NOTE: If you are using a container on a Cradlepoint device that uses cellular connectivity, you will need to supply the API key and tenant ID.

Health checks

ztedge-client supports HTTP health checks. By default this container exposes port 51821/tcp and uses /health path.

External IP automatic updates

The connector container checks its' external IP every 60 seconds. If it detects that the IP has changed, it updates the IP on ZTEdge side and restarts the connenctor process.

NOTE: This feature is only applicable to containers running on Cradlepoint devices that use cellular connectivity and therefore may not have a static IP address.

Deploying in Cradlepoint router

Login to NetCloud Manager and select Configuration -> Edit

1. Under the Edit tab navigate to SYSTEM -> Containers -> Projects

2. Click Add
3. In the Project Config window type the desired name and ensure Enabled box is checked. Then click Compose

4. Copy the content of the cradlepoint-container.yml and paste in the opened window.

NOTE: You need to provide the correct values for tenant connector and key

command: tenant_name connector_name auth_key [api_key] [tenant_id]

Then click on Compose Builder

5. The name of the service under Services menu will be pre-populated. Click on Add under Networks tab and select Primary LAN from the list. Then click Save in the pop-up window and click Save on the bottom of the wizard window.

6. Compose tab will open automatically. Review the Network section which will be pre-populated. Then click Save on the bottom

7. Project will be added to the list. Click Commit on the bottom to push the config to the device

8. In the main dashboard navigate to Containers and ensure that the status of the zte-connector container is Running

zte-connector's Issues

Update image location to Ericom

The image currently resides in a personal docker hub repo instead of the Ericom company repo. Please update.

Current...
docker pull sstarzh/zte-connector:latest