RAMEN-HTTPD

NAME

ramen-httpd - Start an HTTP server.

SYNOPSIS

ramen httpd [OPTION]...

OPTIONS

--api-v1[=VAL] (default=)

Implement ramen API over http.

--daemonize (absent RAMEN_DAEMONIZE env)

Daemonize.

--fault-injection-rate=VAL (absent=1e-06 or RAMEN_FAULT_INJECTION_RATE
env)

Rate at which to generate fake errors.

--graphite[=VAL] (default=)

Impersonate graphite for Grafana.

--help[=FMT] (default=auto)

Show this help in format FMT. The value FMT must be one of ’auto', ’pager', ’groff' or ’plain'. With ’auto', the format is ’pager’ or ’plain' whenever the TERM env var is ’dumb' or undefined.

--prefix-log-with-name (absent RAMEN_PREFIX_LOG_WITH_NAME env)

Prefix every log lines with the service name. Comes handy when all logs are scrambled together, as in the output of docker logs.

--table-prefix=STRING (absent RAMEN_HTTPD_TABLE_PREFIX env)

Only consider tables under this prefix for the API.

--to-stdout, --to-stderr, --stdout, --stderr (absent
RAMEN_LOG_TO_STDERR env)

Log onto stdout/stderr instead of a file.

--to-syslog, --syslog (absent RAMEN_LOG_TO_SYSLOG env)

log using syslog.

--url=VAL (absent=http://127.0.0.1:8080 or RAMEN_URL env)

URL to reach the HTTP service.

--users-dir=PATH (absent RAMEN_USERS_DIR env)

Where to find users directory (defaults to $RAMEN_DIR/confserver/users).

--version

Show version information.

COMMON OPTIONS

--colors=VAL (absent=always or RAMEN_COLORS env)

Whether or not to use colors in terminal output.

--confserver[=VAL] (default=localhost) (absent RAMEN_CONFSERVER env)

host:port of Ramen confserver.

--confserver-key=VAL (absent="" or RAMEN_CONFSERVER_KEY env)

File name where the confserver public key is stored.

-d, --debug (absent RAMEN_DEBUG env)

Increase verbosity.

-i VAL, --identity=VAL (absent RAMEN_CLIENT_IDENTITY env)

Location of the file storing user's identity

--initial-export-duration=VAL (absent=0. or RAMEN_INITIAL_EXPORT env)

How long to export a node output after startup before a client asks for it.

--libs=VAL, --bundle-dir=VAL (absent=/usr/local/libexec/bundle/ or
RAMEN_LIBS env)

Directory where to find libraries for the embedded compiler.

--local-experiments-config=FILE, --experiments-config=FILE (absent
RAMEN_EXPERIMENTS_CONFIG env)

Configuration file for local experiments (defaults to $RAMEN_DIR/experiments/v1/config).

--masters=VAL (absent RAMEN_MASTERS env)

Indicates that Ramen must run in distributed mode and what sites play the master role.

--persist-dir=PATH (absent=/tmp/ramen or RAMEN_DIR env)

Directory where are stored data persisted on disc.

--priv-key=VAL, --client-private-key=VAL (absent=<KEY> or
RAMEN_CLIENT_PRIV_KEY env)

File name where the client private key is stored. This file must not be readable or writable by others.

--pub-key=VAL, --client-public-key=VAL (absent="" or
RAMEN_CLIENT_PUB_KEY env)

File name where the client public key is stored.

-q, --quiet (absent RAMEN_QUIET env)

Decrease verbosity.

--reuse-prev-files (absent RAMEN_REUSE_PREV_FILES env)

Reuse existing source files.

-S, --keep-temp-files (absent RAMEN_KEEP_TEMP_FILES env)

Keep temporary files.

--seed=VAL, --rand-seed=VAL (absent RAMEN_RANDOM_SEED env)

Seed to initialize the random generator with (will use a random one if unset).

--site=VAL (absent HOSTNAME env)

The name of this site.

--username=VAL (absent=_httpd)

Login name to connect to the confserver.

--variant=EXP1=VAR1,EXP2=VAR2... (absent RAMEN_VARIANTS env)

Force variants.

ENVIRONMENT

These environment variables affect the execution of httpd:
HOSTNAME

See option --site.

RAMEN_CLIENT_IDENTITY

See option --identity.

RAMEN_CLIENT_PRIV_KEY

See option --priv-key.

RAMEN_CLIENT_PUB_KEY

See option --pub-key.

RAMEN_COLORS

See option --colors.

RAMEN_CONFSERVER

See option --confserver.

RAMEN_CONFSERVER_KEY

See option --confserver-key.

RAMEN_DAEMONIZE

See option --daemonize.

RAMEN_DEBUG

See option --debug.

RAMEN_DIR

See option --persist-dir.

RAMEN_EXPERIMENTS_CONFIG

See option --experiments-config.

RAMEN_FAULT_INJECTION_RATE

See option --fault-injection-rate.

RAMEN_HTTPD_TABLE_PREFIX

See option --table-prefix.

RAMEN_INITIAL_EXPORT

See option --initial-export-duration.

RAMEN_KEEP_TEMP_FILES

See option --keep-temp-files.

RAMEN_LIBS

See option --bundle-dir.

RAMEN_LOG_TO_STDERR

See option --to-stdout.

RAMEN_LOG_TO_SYSLOG

See option --to-syslog.

RAMEN_MASTERS

See option --masters.

RAMEN_PREFIX_LOG_WITH_NAME

See option --prefix-log-with-name.

RAMEN_QUIET

See option --quiet.

RAMEN_RANDOM_SEED

See option --rand-seed.

RAMEN_REUSE_PREV_FILES

See option --reuse-prev-files.

RAMEN_URL

See option --url.

RAMEN_USERS_DIR

See option --users-dir.

RAMEN_VARIANTS

See option --variant.