CLI Reference

Run Proxyble commands with root privileges because they change local services, firewall state, or traffic controls. The interactive UI is available through sudo proxyble; command-line mode is useful for repeatable operational workflows.

Use built-in help for the exact flags supported by the installed release:

sudo proxyble --help
sudo proxyble --config-listener --help
sudo proxyble --rules-add --help

Configure and run the service

# Set the public listener and protected backend.
sudo proxyble --config-listener --mode http --port 80 --timeout 60s --no-start
sudo proxyble --config-backend --primary-host 127.0.0.1 --primary-port 8080 --no-start

# Review, start, and stop the managed runtime.
sudo proxyble --config-view
sudo proxyble --config-status
sudo proxyble --yes --config-start
sudo proxyble --yes --config-stop

--config-restart is an alias for --config-start; the start workflow applies the rendered configuration by restarting the necessary services.

Manage manual rules

# List, check, add, and reset active rules.
sudo proxyble --rules-list
sudo proxyble --rules-check --ip 203.0.113.25
sudo proxyble --yes --rules-add --rule DROP --target 203.0.113.25 --expiration 10m
sudo proxyble --yes --rules-reset --type LIMIT_CONN_RATE

Use --expiration none only for a deliberate permanent CLI rule. See Manual Rule Actions for compatible actions, limits, and safe removal.

Manage allow-lists

# Allow only selected sources on the listener.
sudo proxyble --basic-allow-list --add 203.0.113.25
sudo proxyble --basic-allow-list --remove 203.0.113.25 --yes

# Protect selected HTTP path prefixes.
sudo proxyble --endpoint-allow-list --add 203.0.113.25 --endpoints /login /api
sudo proxyble --endpoint-allow-list --remove-all --yes

Basic allow-lists work at the listener; endpoint allow-lists require HTTP visibility. Read Protect Access with Allow-Lists before enabling either default-deny control.

Manage analytics policies

# Add RioDB analytics, then deploy and inspect a policy.
sudo proxyble --yes --installation-add-riodb --accept-license
sudo proxyble --policies-deploy --policy api_flood_control --restart-riodb
sudo proxyble --policies-list

# Remove a deployed policy.
sudo proxyble --yes --policies-remove --policy api_flood_control --restart-riodb

--policies-view currently provides the same deployed-policy view as --policies-list. Policy templates and compatibility are covered in the Policy Catalog.

Lifecycle commands

# Remove Proxyble while keeping a Java runtime that other software may use.
sudo proxyble --yes --installation-remove --keep-java

Removal stops services and deletes Proxyble configuration, runtime state, logs, and managed service files. Preserve required audit material before using it. For an up-to-date full command surface, use sudo proxyble --help on the target host and consult the upstream user guide.