Skip to content

Installation

Download and install the SocketXP agent to run on your IoT device so that you could connect to it remotely.

SocketXP agent is a CLI utility with which you can configure and create secure SSL/TLS connection between your device and the SocketXP cloud gateway.

SocketXP agent can be made to run in the background as a Linux Systemd service.

SocketXP agent binary is available for all OS types[Linux, Windows, MacOS] and CPU architectures [x86_64, x86, ARM, ARM64, RISCv64].

Download

SocketXP agent Linux binaries are available for all CPU architectures: x86, ARM, MIPS and RISC. For Raspberry Pi, download the ARM binary. 

curl -O https://portal.socketxp.com/download/linux/amd64/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/386/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/arm/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/arm64/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/armv5/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/mips/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/mipsle/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/mips64/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/mips64le/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/linux/riscv64/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

SocketXP agent MacOS binary is available for the following CPU architectures:

curl -O https://portal.socketxp.com/download/darwin/arm64/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

curl -O https://portal.socketxp.com/download/darwin/amd64/socketxp && chmod +wx socketxp && sudo mv socketxp /usr/local/bin

SocketXP agent Windows binary is available for the following CPU architectures:

Click the link below to download

https://portal.socketxp.com/download/windows/amd64/socketxp.exe

Click the link below to download

https://portal.socketxp.com/download/windows/386/socketxp.exe

Download the SocketXP agent Docker Image from DockerHub using the following command: 

docker pull expresssocket/socketxp
Create a config.json file (explained below) in your local directory and map it as a volume inside the container at /data directory as shown in the example below.

$ docker run -d  -v /home/user/data:/data expresssocket/socketxp
25ad610483f7a324858b79f94de5356c37b3997abc8d105d0eb8ca004c27ec54

$ docker logs 25ad
Using config file: /data/config.json
Login Succeeded.
User [] Email [[email protected]].
Connected.
Public URL -> https://test-user-abcdef1234.socketxp.com
Here is the content of a sample config.json file for the docker container.

$ cat /home/user/data/config.json
{
    "authtoken": "",
    "tunnels" : [{
        "destination": "https://172.10.0.1:8123",
        "custom_domain": "",
        "subdomain": ""
    }]
}
Where 172.10.0.1 is the IP address of the other docker container running your web application (Eg; Python Flask web app or NodeJS web app or a Java web app)

Legacy SocketXP agent version 1.4.5 can be downloaded from the following location: 

    https://portal.socketxp.com/download/1.4.5/linux/amd64/socketxp
    https://portal.socketxp.com/download/1.4.5/linux/arm/socketxp
    https://portal.socketxp.com/download/1.4.5/linux/mipsle/socketxp
    https://portal.socketxp.com/download/1.4.5/windows/amd64/socketxp
    https://portal.socketxp.com/download/1.4.5/darwin/arm64/socketxp
    ...
Note: We recommend all customers to use the latest agent version and not this legacy version.

Verify Installation:

After installing the SocketXP agent, check if it can be executed successfully. 

$ socketxp

Usage:    socketxp [OPTIONS] COMMAND

Socketxp - secure remote access to your IoT devices.

    SocketXP is a cloud based IoT platform that enables users to remotely connect, manage and control IoT devices and IoT web applications running in a private network behind NAT router and firewall.

By using this product, you are agreeing to the terms of SocketXP. Terms of service can be found at: https://www.socketxp.com/tos/

Don't have an account? Create a free account here: https://portal.socketxp.com/#/login

If you have any questions or security related issues, please contact us via email: [email protected].

Options:
      --auto-update             Enable SocketXP agent software
                                auto-update feature
      --config string           config file (default is
                                $HOME/.socketxp/config.json)
      --gateway-domain string   Specify a domain name for the SocketXP
                                Cloud Gateway to connect. (default
                                "gateway.socketxp.com")
      --gateway-port int        Specify an optional SocketXP Cloud
                                Gateway Port to connect. (default 80)
      --help                    Print usage
      --ping-interval int       Specify an optional ping interval for
                                heartbeat messages. (default 90)
      --region string           Specify a SocketXP Cloud Gateway region
                                to connect. Eg: "eu". Default: us-central
  -v, --version                 Print SocketXP agent version and build
                                information

Management Commands:
  service     Install and run socketxp as a background service

Commands:
  connect     Connect the supplied local destination to the public endpoint
  login       Login to the SocketXP service.  Obtain an auth token from https://portal.socketxp.com

Run 'socketxp COMMAND --help' for more information on a command.

Uninstall SocketXP Agent:

To uninstall SocketXP agent from your device execute the following commands:

sudo rm -rf /usr/local/bin/socketxp
sudo rm -rf /var/lib/socketxp
sudo rm -rf /etc/socketxp