Install OpenResty Edge Node

1. Preparation

If your network has a firewall, you need to add the following whitelist. 443 443 443

2. Install OpenResty Edge Node

  • Copy openresty-edge-VERSION.tar.gz to the current directory

  • Decompress

tar -xvf openresty-edge-VERSION.tar.gz
  • Run the installer
cd openresty-edge-VERSION
sudo /bin/bash
  • Enter the action you want to perform Install
What would you like to do?
[1] Install
[2] Upgrade
[3] Downgrade
[4] Uninstall
What you choose is: Install.
  • Enter the version you want to install (The latest version information can be obtained from Changelog)
Which version would you like to install? (like 22.6.1)
  • Enter the component you want to install Edge Node
Which component would you like to install?
[1] Edge Admin DB
[2] Log Server DB
[3] Edge Admin
[4] Log Server
[5] Edge Node
What you choose is: Edge Node.
  • If successful, the following prompt will be displayed at the end
Install Edge Node successfully!

3. Modify the OpenResty Edge Node configuration

Modify the configuration file /usr/local/oredge-node/conf/config.ini with the following contents:

Note: ADMIN_HOST, ADMIN_PORT, LOG_SERVER_HOST, LOG_SERVER_PORT should be replaced with the actual values.

# NOTICE: please feel free to edit these configurations if necessary.


# admin server host, default:
host = "ADMIN_HOST"
port = "ADMIN_PORT"


# log server host, default:

Restart the service after modifying the configuration file:

sudo systemctl start upgrade-oredge-node

The installation of OpenResty Edge Node is now complete.

4. Getting Started

  1. Login to Edge Admin website:

    URL: https://ADMIN_HOST

    If you are trying Edge, the URL and account password for Edge Admin will be sent with your trial email.

    For the trial version, admin is deployed on our machines, while for the future purchase of the full version, we will provide the installation package for self-deployment.

  2. After login, go to the gateway clusters tab, there you will see the join request from the newly deployed node.

    According to the information in the join request, confirm that it is your own node, and then click approve.

    The procedure of approval is to add a new node to a gateway cluster. So before you approve, you need to create a cluster on the GUI, and then you can choose when you approve.


If you have any questions, please contact us.