A Drone plugin for ntfy
Go to file
Tyler Perkins 6a3c872435
continuous-integration/drone/push Build is passing Details
Ntfy dockerhub docs (#15)
* Update README.md

* Remove todo from completed features
2022-12-16 21:31:37 -05:00
.drone.yml Add main branch restriction (#12) 2022-12-16 21:24:37 -05:00
Dockerfile Fix Dockerfile entry point (#6) 2022-12-16 19:59:54 -05:00
LICENSE Initial commit 2022-12-16 18:52:34 -05:00
README.md Ntfy dockerhub docs (#15) 2022-12-16 21:31:37 -05:00
main.sh Make curl u param more dynamic (#13) 2022-12-16 21:26:18 -05:00

README.md

drone-ntfy

Build Status

A Drone plugin for ntfy.

Find the container on docker hub.

Example

The following is an example pipeline where we only send a notification

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.

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 PLUGIN_ATTACH N/A URL or localfile to attach
Icon 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