Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 2.66 KB

README.md

File metadata and controls

51 lines (35 loc) · 2.66 KB

Home Assistant Add-on: Logspout add-on

Send HA logging to remote log management systems

Add-on providing Logspout, including the following adapters:

Logspout collects logs using the Docker API, forwarding them to a choice of destinations using, amongst others, the syslog or GELF protocol. The destination can be for example a logging service like Papertrail or Loggly, or a local running Elasticsearch or Graylog instance.

Because Logspout requires access to the Docker API, protection mode has to be disabled. Access to the Docker API virtually gives access to the whole system, resulting in a rating of 1 for this add-on. Logspout only uses the API to read container properties and the stdout/stderr output of the containers.

Installation

  1. Ensure that 'Advanced Mode' is enabled in your user profile (bottom-left in HA)

  2. Click the Home Assistant My button below to add this repository to your Home Assistant

    Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

  3. Install the Logspout add-on

  4. Disable 'protection mode' (lowest toggle on the Information tab)

  5. Review the configuration (on the Configuration tab)

  6. Start the add-on

  7. Verify the log output on the Log tab

Configuration

See the Documentation tab or DOCS.md for for more information.

More information

Issue tracker https://github.com/bertbaron/hassio-addons/issues

Discussions https://community.home-assistant.io/t/logspout-add-on-for-sending-ha-logs-to-log-management-systems/423152

The build setup is based on the logspout-gelf container.

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture privileged