OpenResty Edge™ CLI User Manual

Documentation of Edge CLI utility oredge

oredge is a command line utility for OpenResty Edge.


Installation

This document describe how to install edge-cli. We will need to access the following public network addresses.

Overview

The default config file is ~/.oredge/config. oredge help will print the usage of the command.

app

app.

cache

–http HTTP_APP_ID Specify to which HTTP application the cache is purged. HTTPAPPID is the ID of the HTTP application.

socks5-proxy

socks5-proxy.

http-proxy

http-proxy.

gateway

gateway.

dns

dns.

http-var

http-var.

k8s

k8s.

upstream

upstream.

page-rule

This command corresponds to the functions on the page of page rules. For how to specify a page rule, check rule definition part.

dns-record

create a A DNS record for DNS id 1(foo.com), then the DNS query A record for tt.foo.com return 10.1.1.1 create a CNAME DNS record for DNS id.

http-proxy-auth

create HTTP proxy authentication. create HTTP proxy authentication with –start-time and –end-time modify HTTP proxy authentication.

cert

cert.

txlog

txlog.

global-config

PARTITION_ID Specify the partition you want to configure. –worker-connections number Specify the number of worker connections.

test

test.

port

port.

partition

partition.

user

user.

user-group

user-group.

webhook

webhook.

waf

waf.

lua-module

lua-module.

lua-extension

create lua extension with trigger type event. create lua extension with trigger type corn.

dymetrics

dymetrics.

layer-policy

layer-policy.

acme-provider

acme-provider.

app-ip-list

This command corresponds to the function on the page of application IP list. This command can create an app-ip-list in an application.

global-cert

This command corresponds to the function on the page of global cert. This command is used to create a global-cert.

global-ip-list

This command corresponds to the function on the page of global IP list. This command can create a global-ip-list.