NOVA-SPICEHTML5PROXY(1)

📦
version 34.0.0 · 10 versions
, in ubuntu stonking

💖 NOVA-SPICEHTML5PROXY 💖

okay bestie, gather round, because today we're talking about nova-spicehtml5proxy — that's the manual page, section 1, straight out of the nova fam. she's a whole server daemon and she SERVES. let's get into it 💅

✨ SYNOPSIS ✨

nova-spicehtml5proxy [<options>...]

🌸 DESCRIPTION 🌸

so nova-spicehtml5proxy is a server daemon, right? she's out here serving the Nova SPICE HTML5 Websocket Proxy service. and what does that do? it provides a websocket proxy that is compatible with OpenStack Nova SPICE HTML5 consoles. that's it. that's the job. iconic behavior honestly 🦋

✨ OPTIONS ✨

💜 General options

  • --config-dir DIR — path to a config directory, and she's gonna pull all the *.conf files out of it. this set is sorted, so you get a predictable parse order in case individual options are over-ridden. the set gets parsed after the file(s) you named via previous --config-file arguments, which means over-ridden options in the directory take precedence. ⚠️ this option must be set from the command-line, no cap.
  • --config-file PATH — path to a config file to use. multiple config files? absolutely, specify away, values in later files take precedence. defaults to None. and yeah, this one must be set from the command-line too.
  • --debug, -d — sets the logging level to DEBUG instead of the default INFO level. loud and proud, we love that for her 🔥
  • --log-config-append PATH, --log-config PATH, --log_config PATH — the name of a logging configuration file. this file gets appended to any existing logging configuration files. for the deets about logging configuration files, go peek at the Python logging module documentation. heads up bestie: when logging configuration files are used, then all logging configuration is set in the configuration file, and every other logging configuration option gets ignored (looking at you, log-date-format) 🙈
  • --log-date-format DATE_FORMAT — defines the format string for %(asctime)s in log records. default: None. this option is ignored if log_config_append is set.
  • --log-dir LOG_DIR, --logdir LOG_DIR — (optional) the base directory used for relative log_file paths. ignored if log_config_append is set.
  • --log-file PATH, --logfile PATH — (optional) name of the log file to send logging output to. if no default is set, logging will go to stderr as defined by use_stderr. ignored if log_config_append is set.
  • --nodebug — the inverse of --debug. (the "actually, no" button ✋)
  • --nouse-journal — the inverse of --use-journal.
  • --nouse-json — the inverse of --use-json.
  • --nouse-syslog — the inverse of --use-syslog.
  • --nowatch-log-file — the inverse of --watch-log-file.
  • --syslog-log-facility SYSLOG_LOG_FACILITY — the syslog facility to receive log lines. ignored if log_config_append is set.
  • --use-journal — enable journald for logging. if you're running in a systemd environment you may wish to enable journal support. doing so will use the journal native protocol, which includes structured metadata in addition to log messages. this option is ignored if log_config_append is set. ✨
  • --use-json — use JSON formatting for logging. ignored if log_config_append is set.
  • --use-syslog — use syslog for logging. 🚨 the existing syslog format is DEPRECATED and will be changed later to honor RFC5424. this option is ignored if log_config_append is set.
  • --version — show the program's version number and exit. bye bestie 👋
  • --watch-log-file — uses a logging handler designed to watch the file system. when the log file is moved or removed, this handler will open a new log file with the specified path instantaneously. it makes sense only if the log_file option is specified and the Linux platform is used. ignored if log_config_append is set.

🧚 Websockify options

  • --cert CERT — path to the SSL certificate file.
  • --daemon — run as a background process. main character energy, off doing her own thing in the background 💅
  • --key KEY — SSL key file (if it's separate from the cert).
  • --nodaemon — the inverse of --daemon.
  • --nosource_is_ipv6 — the inverse of --source_is_ipv6.
  • --nossl_only — the inverse of --ssl_only.
  • --record RECORD — filename that will be used for storing websocket frames received and sent by a proxy service (like VNC, spice, serial) running on this host. if this isn't set, no recording will be done. 📼
  • --source_is_ipv6 — set to True if the source host is addressed with IPv6.
  • --ssl_only — disallow non-encrypted connections. 🔒
  • --web WEB — path to the directory with content which will be served by a web server.

🎀 Spice options

  • --spice-html5proxy_host SPICE_HTML5PROXY_HOST — the IP address or a hostname on which the nova-spicehtml5proxy service listens for incoming requests. this option depends on the [spice] html5proxy_base_url option in nova.conf. and listen: the nova-spicehtml5proxy service must be listening on a host that is accessible from the HTML5 client. no sneaky localhost-only setups, bestie 🫶
  • --spice-html5proxy_port SPICE_HTML5PROXY_PORT — the port on which the nova-spicehtml5proxy service listens for incoming requests. this option depends on the [spice] html5proxy_base_url option in nova.conf. the nova-spicehtml5proxy service must be listening on a port that is accessible from the HTML5 client. same energy, same rule 💖

📁 FILES 📁

the sacred texts, keep them safe:

  • /etc/nova/nova.conf
  • /etc/nova/rootwrap.conf
  • /etc/nova/rootwrap.d/

👀 SEE ALSO 👀

siblings!! go read theirs too, family reunion vibes 🌈

💀 BUGS 💀

found a bug? go tell Launchpad, not me 😭

🖋️ Author

openstack@lists.openstack.org

2010-present, OpenStack Foundation

<div>so that's the whole page, bestie. she's nova-spicehtml5proxy, she's version 34.0.0, and this hot off the press edition is dated Oct 01, 2026 — go forth and proxy those SPICE HTML5 consoles responsibly ✨💜🦋</div>

📦 where this page comes from