Railgun consists of two programs: rg-listener and rg-sender.
rg-listener is to be installed at a hosting provider or end-user
environment and listens for WAN connections. rg-sender is to be installed
at CloudFlare locations and establishes connections across the WAN.
rg-sender acts as an HTTP proxy and accepts HTTP requests (with the
CF-ORIGIN-IP and CF-WAN-ID headers) and sends them across the WAN to the
rg-listener which then contacts the real web server.
Both ends use memcached for page caching for the delta compression. If
memcached is not working then both ends still operate without delta
Both programs write a log file containing detailed information about operation.
rg-listener reads a configuration file named ‘rg.config‘ which is assumed
to be in the same directory as the program. The location of the configuration
file can be set on the command line with the ‘-config‘ option.
- -config[=| ]PATH
- The path to the rg.config configuration file to use
||Output version information and exit|
- The IP on which to listen for WAN connections. Default to an empty string meaning all interfaces.
- The port on which to listen for WAN connections. Defaults to 2408.
- Name of log file to write stderr messages to. Useful for debugging crashes.
- The maximum level of log message to output. 0 = errors only; 1 = informational messages; 5 = debugging. The default is 0.
- The network address (hostname:port) of the syslog server to connect to using UDP, or a path for a connection using a Unix domain socket. Defaults to the empty string which means that the system configured syslog will be used via a Unix domain socket.
- The number of seconds to wait while trying to connect to a web server. Defaults to 30.
- Whether to use TLS for the WAN connection. Defaults to 1 and should only be set to 0 for testing. If no certificate files are provided, but wan.tls=1 and activate.server is non-empty rg-listener will attempt to acquire a certificate from the activation server.
- Space separated list of memcached servers in host:port format that will be used for caching. There is not default and this must be set.
- The maximum amount of time (in ms) to wait for retrieval of a cached page from memcached. The default is 100.
- The expiration time of individual memcached items in seconds. The default is 600 seconds (10 minutes). If set to 0 then the expiration time is infinite.
- The host:port for the memcached server. Defaults to 127.0.0.1:11211
- The maximum size (in bytes) of pages that will be stored in memcached. Defaults to 100,000.
- Determines whether statistics are gathered or not. Defaults to 0 (set to 1 for statistics output)
- Sets the URL (e.g. http://stats.example.com:9090/) to periodically POST stats to. Defaults to empty for disabled.
- Determines whether stats are periodically written to syslog. Defaults to 0 (set to 1 for logged statistics).
- How often (in minutes) stats are generated (and logged and POSTed to the stats.url). Default is 1 indicating every minute.
- host:port on which to listen and create a simple HTTP JSON API through which stats can be read via a ‘GET /‘. Defaults to empty for disabled.
- The name of a file into which the PID will be written. Defaults to an empty string which means that no PID file is created.
- Name of file containing the certificate presented by this server to connections. No default.
- Name of file containing the private key for the cert.file. No default.
- Whether to validate the certificate presented when making a TLS connection. Defaults to 1 (meaning perform the validation)
- Name of a file containing domain=ip pairs that is used to override DNS and the CF-ORIGIN-IP setting. Defaults to no file.
- The public facing, resolvable, hostname through which the CF CDN can connect to this rg-listener. DNS lookups are done at request-time. Use in place of activation.public_ip.
- The external IP (or a hostname which resolves to the IP) of your Railgun instance used for activation and automatic DNS record updates. No Default.
- 32 character hash used for activation (see https://www.cloudflare.com/a/account/my-account). No default.
- Interval, in seconds, between heartbeats to activation server. Defaults to 0/off.
- Name of the file to which the heap profile will be written when SIGUSR1 is received. There is no default value which means that the memory profile will not be created and memory profiling will be disabled.
- Name of the file to which the CPU profile will be written when SIGUSR1 is received. There is no default value which means that the CPU profile will not be created. Note that the SIGUSR1 signal toggles profiling on and off and the file will be written on every transition to off.
- Whether to begin profiling immediately on startup. It is only valid when cpuprofile.file is set and valid. It is 0 by default, requiring an explicit signal to begin profiling.
- Name of the file to which information about current memory use will be written when SIGUSR2 is received. This is intended for internal use.
- Name of a file containing PEM-encoded CA root certificates that will be used for verifying connections to origin servers using TLS. Defaults to empty string which means use the system roots.
- Create a rg.config file containing the parameters above.
- Start memcached and then run rg-listener with the -config option set to
the path of the rg.config file. Errors on start will output to stderr.
Railgun handles some signals for easier daemon control.
- Reload configuration file. Certain configuration options cannot be
dynamically changed and require a full restart. The following parameters
can be changed at runtime: compress.data, lan.timeout, log.level, map.file,
memcached.expiration, memcached.limit, memcached.servers, memcached.timeout,
stats.url, syslog.addr, validate.cert
- Perform a graceful shutdown without dropping active connections. Upon
successful shutdown, deactivate the Railgun matching the
activation.token via the CloudFlare API until the instance is
- Perform a binary upgrade by spawning a new child, and then terminating the previously
running parent process. This signal is automatically sent during the
post-install for binary yum/apt package upgrades.