Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tystuyfzand committed Jul 22, 2021
1 parent 38564ed commit 3624c44
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
Gotify-SMTP
Gotify-MQTT
===========

A plugin for piping email messages into [Gotify](https://gotify.net/) without ever hitting an email service. Inspiration for this comes from MailHog and similar implementations where there is no backing email service, it simply forwards/receives messages as needed.

There are other versions of this (specifically using the API), however this is a standalone plugin that can be loaded by Gotify.
A plugin for using [Gotify](https://gotify.net/) to ingest messages from MQTT.

Usage
-----

Download the plugin from the releases page, or build it from source (using the Makefile).

Point your application settings at GOTIFY_IP port 1025, with the username being the name of the account you'd like to send messages to.
Configure the settings and add your MQTT Brokers.

Example config:

Limitations
-----------
```yaml
servers:
- address: 127.0.0.1:1883
username: ""
password: ""
subscribe:
- 'gotify/mqtt'

Currently, HTML messages aren't supported. Markdown might be possible, but currently not planned as most if not all messages include a text/plain variation.
```

0 comments on commit 3624c44

Please sign in to comment.