Skip to content

Latest commit

 

History

History
165 lines (147 loc) · 5.38 KB

README.md

File metadata and controls

165 lines (147 loc) · 5.38 KB
Raw

TzProxy

TzProxy is a reverse proxy specifically designed for Tezos nodes, offering a range of features that enhance node performance, security, and manageability.

Features

  • Rate limit
  • Block IPs
  • Blocklist routes
  • Cache
  • CORS
  • GZIP
  • Metrics
  • Redis

How to run

Make sure that your Tezos Node is running and set its host address in the tezos_host configuration.

If you want to test only TzProxy without a real Tezos Node, you can simulate a Tezos Node with our flextesa.sh script. Make sure that you have a docker.

./flextesa.sh

If you want custom configurations, create a file named as tzproxy.yaml in the same directory of the binary. This file will be created if you don't create it.

Then, just download the binary and run it:

./tzproxy

Finally, test it with:

curl http://localhost:8080/chains/main/blocks/head/header

Configuration

Yaml File

Here a default tzproxy.yaml file:

allow_routes:
    enabled: true
    values:
        - GET/chains/.*/blocks
        - GET/chains/.*/chain_id
        - GET/chains.*/checkpoint
        - GET/chains/.*/invalid_blocks
        - GET/chains.*/invalid_blocks.*
        - GET/chains/.*/is_bootstrapped
        - GET/chains.*/mempool/filter
        - GET/chains/.*/mempool/monitor_operations
        - GET/chains/.*/mempool/pending_operations
        - GET/config/network/user_activated_protocol_overrides
        - GET/config/network/user_activated_upgrades
        - GET/config/network/dal
        - GET/describe.*
        - GET/errors
        - GET/monitor.*
        - GET/network/greylist/ips
        - GET/network/greylist/peers
        - GET/network/self
        - GET/network/stat
        - GET/network/version
        - GET/network/versions
        - GET/protocols
        - GET/protocols.*
        - GET/protocols.*/environment
        - GET/version
        - POST/chains/.*/blocks/.*/helpers
        - POST/chains/.*/blocks/.*/script
        - POST/chains/.*/blocks/.*/context/contracts.*/big_map_get
        - POST/injection/operation
cache:
    disabled_routes:
        - GET/monitor/.*
        - GET/chains/.*/mempool
        - GET/chains/.*/blocks.*head
    enabled: true
    size_mb: 100
    ttl: 5
cors:
    enabled: true
deny_ips:
    enabled: false
    values: []
deny_routes:
    enabled: true
    values:
        - GET/workers.*
        - GET/worker.*
        - GET/stats.*
        - GET/chains/.*/blocks/.*/helpers/baking_rights
        - GET/chains/.*/blocks/.*/helpers/endorsing_rights
        - GET/helpers/baking_rights
        - GET/helpers/endorsing_rights
        - GET/chains/.*/blocks/.*/context/contracts(/?)$
        - GET/chains/.*/blocks/.*/context/raw/bytes
        - POST/injection/block
        - POST/injection/protocol
dev_mode: false
gc:
    optimize_memory_store: true
    percent: 100
gzip:
    enabled: true
host: 0.0.0.0:8080
load_balancer:
    ttl: 600
logger:
    bunch_size: 1000
    pool_interval_seconds: 1
metrics:
    enabled: true
    host: 0.0.0.0:9000
    pprof: false
rate_limit:
    enabled: false
    max: 300
    minutes: 1
redis:
    enabled: false
    host: ""
tezos_host:
    - 127.0.0.1:8732
tezos_host_retry: ""

Environment Variables

You can also configure or overwrite TzProxy with environment variables, using the same structure:

  • TZPROXY_DEV_MODE is a flag to enable dev features like pretty logger.
  • TZPROXY_HOST is the host of the proxy.
  • TZPROXY_TEZOS_HOST are the hosts of the tezos nodes.
  • TZPROXY_TEZOS_HOST_RETRY is the host used when finding a 404 or 410. It's recommended use full or archive nodes.
  • TZPROXY_REDIS_HOST is the host of the redis.
  • TZPROXY_REDIS_ENABLE is a flag to enable redis.
  • TZPROXY_LOAD_BALANCER_TTL is the time to live to keep using the same node by user IP.
  • TZPROXY_LOGGER_BUNCH_SIZE is the bunch size of the logger.
  • TZPROXY_LOGGER_POOL_INTERVAL_SECONDS is the pool interval of the logger.
  • TZPROXY_CACHE_ENABLED is the flag to cache enable cache.
  • TZPROXY_CACHE_DISABLED_ROUTES is the variable with the routes to cache.
  • TZPROXY_CACHE_SIZE_MB is the size of the cache in megabytes.
  • TZPROXY_CACHE_TTL is the time to live in seconds for cache.
  • TZPROXY_RATE_LIMIT_ENABLED is a flag to enable rate limiting.
  • TZPROXY_RATE_LIMIT_MINUTES is the minutes of the period of rate limiting.
  • TZPROXY_RATE_LIMIT_MAX is the max of requests permitted in a period.
  • TZPROXY_DENY_IPS_ENABLED is a flag to block IP addresses.
  • TZPROXY_DENY_IPS_VALUES is the IP Address that will be blocked on the proxy.
  • TZPROXY_DENY_ROUTES_ENABLED is a flag to block the Tezos node's routes.
  • TZPROXY_DENY_ROUTES_VALUES is the Tezos nodes routes that will be blocked on the proxy.conf.
  • TZPROXY_ALLOW_ROUTES_ENABLED is a flag to allow the Tezos node's routes.
  • TZPROXY_ALLOW_ROUTES_VALUES is the Tezos nodes routes that will be allowed on the proxy.conf.
  • TZPROXY_METRICS_ENABLED is the flag to enable metrics.
  • TZPROXY_METRICS_PPROF is the flag to enable pprof.
  • TZPROXY_METRICS_HOST is the host of the prometheus metrics and pprof (if enabled).
  • TZPROXY_CORS_ENABLED is the flag to enable cors.
  • TZPROXY_GZIP_ENABLED is the flag to enable gzip.
  • TZPROXY_GC_OPTIMIZE_MEMORY_STORE is a flag to optimize GC when it's using storage as memory allocations instead of redis.
  • TZPROXY_GC_PERCENT is the percent of the garbage collector.