Skip to main content

No project description provided

Project description

Rhasspy Hermes Web Server

Continous Integration GitHub license

Web interface to Rhasspy using Hermes protocol on the back end.

Running With Docker

docker run -it rhasspy/rhasspy-server-hermes:<VERSION> <ARGS>

Building From Source

Clone the repository and create the virtual environment:

git clone https://github.com/rhasspy/rhasspy-server-hermes.git
cd rhasspy-server-hermes
make venv

Before running, you will need to put the generated artifacts (dist directory) from rhasspy-web-vue in a directory named web.

Run the bin/rhasspy-server-hermes script to access the command-line interface:

bin/rhasspy-server-hermes --help

Building the Debian Package

Before building, you will need to put the generated artifacts (dist directory) from rhasspy-web-vue in a directory named web.

Follow the instructions to build from source, then run:

source .venv/bin/activate
make debian

If successful, you'll find a .deb file in the dist directory that can be installed with apt.

Building the Docker Image

Before building, you will need to put the generated artifacts (dist directory) from rhasspy-web-vue in a directory named web.

Follow the instructions to build from source, then run:

source .venv/bin/activate
make docker

This will create a Docker image tagged rhasspy/rhasspy-server-hermes:<VERSION> where VERSION comes from the file of the same name in the source root directory.

NOTE: If you add things to the Docker image, make sure to whitelist them in .dockerignore.

Command-Line Options

usage: Rhasspy [-h] --profile PROFILE [--host HOST] [--port PORT]
               [--mqtt-host MQTT_HOST] [--mqtt-port MQTT_PORT]
               [--local-mqtt-port LOCAL_MQTT_PORT]
               [--system-profiles SYSTEM_PROFILES]
               [--user-profiles USER_PROFILES] [--set SET SET] [--ssl SSL SSL]
               [--log-level LOG_LEVEL] [--web-dir WEB_DIR]

optional arguments:
  -h, --help            show this help message and exit
  --profile PROFILE, -p PROFILE
                        Name of profile to load
  --host HOST           Host for web server
  --port PORT           Port for web server
  --mqtt-host MQTT_HOST
                        Host for MQTT broker
  --mqtt-port MQTT_PORT
                        Port for MQTT broker
  --local-mqtt-port LOCAL_MQTT_PORT
                        Port to use for internal MQTT broker (default: 12183)
  --system-profiles SYSTEM_PROFILES
                        Directory with base profile files (read only)
  --user-profiles USER_PROFILES
                        Directory with user profile files (read/write)
  --set SET SET, -s SET SET
                        Set a profile setting value
  --ssl SSL SSL         Use SSL with <CERT_FILE <KEY_FILE>
  --log-level LOG_LEVEL
                        Set logging level
  --web-dir WEB_DIR     Directory with compiled Vue site (default: dist)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rhasspy-server-hermes, version 2.5.0
Filename, size File type Python version Upload date Hashes
Filename, size rhasspy-server-hermes-2.5.0.tar.gz (29.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page