tyler
/
drone-ntfy
mirror of https://github.com/Clortox/drone-ntfy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Documentation (#7)
continuous-integration/drone/push Build is passing Details 

* Add Dockerfile and main.sh

* Add base settings for now

* Add drone

* Fix typo in alpine name

* Add ntfy service to drone

* Update dockerfile

* Fix entry point in Dockerfile

* Update README with options
This commit is contained in:
Tyler Perkins 2022-12-16 20:12:40 -05:00 committed by GitHub
parent 0ca6b05d20
commit 4bab19d289
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -2,5 +2,44 @@
A [Drone](https://drone.io) plugin for ntfy.
## Example
The following is an example pipeline where we only send a notification
```yaml
steps:
- name:
image: clortox/drone-ntfy
settings:
URL: https://ntfy.clortox.com
USERNAME: drone
PASSWORD:
from_secret: ntfy_password
TOPIC: drone-builds
MESSAGE: Drone build done!
CLICK: https://drone.clortox.com/tyler/drone-ntfy
TITLE: Drone (Drone-ntfy)
```
A living, breathing example of this is in this repository's [drone file](.drone.yml).
## Options
There are several options that you can configure when sending the notification.
Note that the `ntfy Name` is the name you will use in the settings section of
your configuration.
| ntfy Name | Container Environment Variable | Default Value | Description |
| -------- | ------ | ----- | ----------- |
| Priority | PLUGIN_PRIORITY | N/A | Notification Priority |
| Title | PLUGIN_TITLE | N/A | Title of the notification |
| Tags | PLUGIN_TAGS | N/A | Emojis on the notification |
| Click | PLUGIN_CLICK | N/A | URL to navigate to if the user clicks the notification |
| Attach (TODO) | PLUGIN_ATTACH | N/A | URL or localfile to attach |
| Icon (TODO) | PLUGIN_ICON | N/A | Icon to display |
| URL | PLUGIN_URL | ntfy.sh | URL to send the notification to |
| Topic | PLUGIN_TOPIC | drone-notifications | The notification top to send this to |
| Message | PLUGIN_MESSAGE | Pipeline Finished! | The body of the notification |
| Username | PLUGIN_USERNAME | N/A | The username to authenticate with |
| Password | PLUGIN_PASSWORD | N/A | The password to authenticate with |