https://github.com/paviro/MMM-syslog

API for sending notifications to your mirror.
https://github.com/paviro/MMM-syslog

Last synced: about 2 months ago
JSON representation

API for sending notifications to your mirror.

• Host: GitHub
• URL: https://github.com/paviro/MMM-syslog
• Owner: paviro
• Archived: true
• Created: 2016-07-08T12:50:34.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-12T19:58:06.000Z (almost 7 years ago)
• Last Synced: 2024-08-04T10:02:44.761Z (5 months ago)
• Language: JavaScript
• Size: 80.1 KB
• Stars: 38
• Watchers: 13
• Forks: 15
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-mmm - **MMM-syslog**

README

        
# MMM-syslog

Notification API Module for MagicMirror2

## Example

![](https://forum.magicmirror.builders/uploads/files/1473753516823-syslog-icon-4.jpg)

## Dependencies

  * An installation of [MagicMirror2](https://github.com/MichMich/MagicMirror)

## Installation

 1. Clone this repo into `~/MagicMirror/modules` directory.

 2. Configure your `~/MagicMirror/config/config.js`:

    ```

    {

        module: 'MMM-syslog',

        position: 'top_right',

        config: {

            ...

        }

    }

    ```

## Config Options

| **Option** | **Default** | **Description** |

| --- | --- | --- |

| `max` | `5` | How many messages should be displayed on the screen. |

| `format` | `false` | Displays relative date format, for absolute date format provide a string like `'DD:MM HH:mm'` [All Options](http://momentjs.com/docs/#/displaying/format/) |

| `types` | `{INFO: "dimmed", WARNING: "normal", ERROR: "bright"}` | Object with message types and their css class. |

| `shortenMessage` | `false` | After how many characters the message should be cut. Default: show all. |

| `alert` | `true` | Display notification? |

## How to Use

Make an http get request like:

  http://MIRROR_IP:MIRROR_PORT/syslog?type=INFO&message=YOUR_MESSAGE&silent=true : no notification