NOVA-NOVNCPROXY(1)

📦
version 34.0.0 · 12 versions
, in ubuntu stonking

💅 NOVA-NOVNCPROXY 💅

okay bestie, welcome to the manual for nova-novncproxy — think of this whole page as the group chat where I explain it to you, except every single fact is still here, no cap. 🫶

✨ NAME ✨

nova-novncproxy — it's a server for the OpenStack Compute VNC console proxy service. that's the whole vibe. 👑

🌸 SYNOPSIS 🌸

nova-novncproxy [<options>...]

🦋 DESCRIPTION 🦋

so. nova-novncproxy is a server daemon, right? and what it serves is the Nova noVNC Websocket Proxy service. which is — and I'm being so serious rn — a websocket proxy that's compatible with OpenStack Nova noVNC consoles. that's it. that's the job. it proxies, it websockets, it slays. ✨

💖 OPTIONS 💖

🎀 General options 🎀

  • --config-dir DIR — path to a config directory you wanna pull *.conf files from. here's the tea: that file set gets sorted, so the parse order stays predictable if individual options are over-ridden. it's parsed after the file(s) you gave via previous --config-file args, so over-ridden options in the directory win. also, this one must be set from the command-line. no sneaking it in elsewhere. 💅
  • --config-file PATH — path to a config file. you can list multiple config files and the values in later files take precedence. defaults to None. and yes, like its sibling above, this one must be set from the command-line.
  • --debug, -d — bumps the logging level to DEBUG instead of the default INFO level. loud and proud. 🔥
  • --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 config files. for the deets on logging config files, go look at the Python logging module documentation. heads up though: when logging config files are in play, all logging configuration gets set in the config file and the other logging config options get ignored (like, say, log-date-format, for example). 🫨
  • --log-date-format DATE_FORMAT — defines the format string for %(asctime)s in log records. default: None. this option gets 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 goes to stderr as defined by use_stderr. ignored if log_config_append is set.
  • --nodebug — the inverse of --debug. the anti-debug, if you will. 🙈
  • --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 — 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 might wanna enable journal support. doing so uses 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. real talk: 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. short, iconic, done. 💅
  • --watch-log-file — uses a logging handler designed to watch the file system. when the log file is moved or removed, this handler opens a new log file with the specified path instantaneously. it only makes sense if the log_file option is specified and you're on a Linux platform. 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, but offscreen. 🌙
  • --key KEY — SSL key file (if it's separate from 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'll 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 gets done. no receipts. 📼
  • --source_is_ipv6 — set to True if the source host is addressed with IPv6.
  • --ssl_only — disallow non-encrypted connections. lock the door, bestie. 🔒
  • --web WEB — path to the directory with content that'll be served by a web server.

🧚 VNC options 🧚

  • --vnc-auth_schemes VNC_AUTH_SCHEMES — the authentication schemes to use with the compute node. this controls what RFB authentication schemes are permitted for connections between the proxy and the compute host. if multiple schemes are enabled, the first matching scheme gets used — so list the strongest schemes first. order matters, periodt. 💪
  • --vnc-novncproxy_host VNC_NOVNCPROXY_HOST — IP address that the noVNC console proxy should bind to. quick context: the VNC proxy is an OpenStack component that lets compute service users access their instances through VNC clients, and noVNC provides VNC support through a websocket-based client. this option sets the private address the noVNC console proxy service should bind to.
  • --vnc-novncproxy_port VNC_NOVNCPROXY_PORT — port that the noVNC console proxy should bind to. same lore as above: the VNC proxy is an OpenStack component that lets compute service users get to their instances through VNC clients, noVNC does VNC over a websocket-based client, and this option sets the private port the noVNC console proxy service should bind to. 🔌
  • --vnc-vencrypt_ca_certs VNC_VENCRYPT_CA_CERTS — the path to the CA certificate PEM file. like, the fully qualified path to a PEM file containing one or more x509 certificates for the certificate authorities used by the compute node VNC server. 📜
  • --vnc-vencrypt_client_cert VNC_VENCRYPT_CLIENT_CERT — the path to the client key file (for x509). the fully qualified path to a PEM file containing the x509 certificate which the VNC proxy server presents to the compute node during VNC authentication.
  • --vnc-vencrypt_client_key VNC_VENCRYPT_CLIENT_KEY — the path to the client certificate PEM file (for x509). the fully qualified path to a PEM file containing the private key which the VNC proxy server presents to the compute node during VNC authentication.

📁 FILES 📁

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

👀 SEE ALSO 👀

💀 BUGS 💀

not me telling you to file your bugs properly... but like, file your bugs properly bestie 🫶

🌟 Author 🌟

openstack@lists.openstack.org

2010-present, OpenStack Foundation

and that's the whole page, you're officially educated 💅✨ version 34.0.0, dated Oct 01, 2026 — bye bestie, go proxy something iconic 🦋🌸

📦 where this page comes from