v/pingme
1
0
Fork 0
mirror of https://github.com/kha7iq/pingme.git synced 2025-05-15 22:30:11 -07:00
Code Issues Projects Releases Wiki Activity

docs: add pushbullet service docs

Browse Source
This commit is contained in:
kha7iq 2021-04-28 00:58:13 +08:00
parent 11ca633fca
commit 7e1593e8a2
4 changed files with 103 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -24,14 +24,13 @@
</p>
<p align="center">
<a href="#about">About</a> •
<a href="https://kha7iq.github.io/pingme">Documentation</a> •
<a href="#supported-services">Supported Services</a> •
<a href="#install">Install</a> •
<a href="#github-action">Github Action</a> •
<a href="#configuration">Configuration</a> •
<a href="#contributing">Contributing</a> •
<a href="#show-your-support">Show Your Support</a> •
<a href="#show-your-support">Show Your Support</a>
</p>
---
@ -45,7 +44,7 @@ And i can ship it everywhere with ease.
Hence, the birth of PingMe.
Everything is configurable via environment variables, and you can simply export the logs or messages to a variable which will be sent
as message. And most of all this serves as a swiss army knife sort of tool which supports multiple platforms.
as message, and most of all this serves as a swiss army knife sort of tool which supports multiple platforms.
@ -53,20 +52,28 @@ as message. And most of all this serves as a swiss army knife sort of tool which
- *Discord*
- *Email*
- *Microsoft Teams*
- *Mattermost*
- *Pushover*
- *Pushbullet*
- *RocketChat*
- *Slack*
- *Telegram*
- *Pushover*
- *Mattermost*
## Install
### Linux & MacOs
### MacOS & Linux Homebrew
```bash
brew install kha7iq/tap/pingme
```
## Linux Binary
```bash
wget -q https://github.com/kha7iq/pingme/releases/download/v0.1.6/pingme_Linux_x86_64.tar.gz
tar -xf pingme_Linux_x86_64.tar.gz
chmod +x pingme
sudo mv pingme /usr/local/bin/pingme
```
### Go Get
```bash
go get -u github.com/kha7iq/pingme
@ -91,7 +98,7 @@ Docker Registry
```bash
docker pull khaliq/pingme:latest
```
Gighub Registry
Github Registry
```bash
docker pull ghcr.io/kha7iq/pingme:latest
```
@ -132,6 +139,7 @@ COMMANDS:
pushover Send message to pushover
email Send an email
mattermost Send message to mattermost
pushbullet Send message to pushbullet
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:

9
docs/home.md
View File

@ -33,24 +33,25 @@
## About
**PingMe** is a personal project to satisfy my needs of having alerts, most major platforms have integration to send alerts
but its not always useful, either you are stuck with one particular platform, or you have to do alot of integrations. I needed a small app
but it's not always useful, either you are stuck with one particular platform, or you have to do alot of integrations. I needed a small app
which i can just call from my backup scripts, cron jobs, CI/CD pipelines or from anywhere to send a message with particular information.
And i can ship it everywhere with ease.
Hence, the birth of PingMe.
Everything is configurable via environment variables, and you can simply export the logs or messages to a variable which will be sent
as message. And most of all this serves as a swiss army knife sort of tool which supports multiple platforms.
as message, and most of all this serves as a swiss army knife sort of tool which supports multiple platforms.
## Supported services
- *Discord*
- *Email*
- *Microsoft Teams*
- *Mattermost*
- *Pushover*
- *Pushbullet*
- *RocketChat*
- *Slack*
- *Telegram*
- *Pushover*
- *Mattermost*

14
docs/install.md
View File

@ -1,9 +1,17 @@
## Linux & MacOs
## MacOS & Linux Homebrew
```bash
brew install kha7iq/tap/pingme
```
## Linux Binary
```bash
wget -q https://github.com/kha7iq/pingme/releases/download/v0.1.6/pingme_Linux_x86_64.tar.gz
tar -xf pingme_Linux_x86_64.tar.gz
chmod +x pingme
sudo mv
```
## Go Get
```bash
go get -u github.com/kha7iq/pingme
@ -29,7 +37,7 @@ Checkout [release](https://github.com/kha7iq/pingme/releases) page for available
```bash
docker pull khaliq/pingme:latest
```
- Github Registry
- GitHub Registry
```bash
docker pull ghcr.io/kha7iq/pingme:latest
```
@ -39,7 +47,7 @@ docker run ghcr.io/kha7iq/pingme:latest
```
## Github Action
## GitHub Action
A github action is also available now for this app, you can find it on [Github Market Place](https://github.com/marketplace/actions/pingme-action) or from this [repository](https://github.com/kha7iq/pingme-action) on github.
Usage examples for workflow are available in the repo.

93
docs/services.md
View File

@ -19,7 +19,7 @@ Multiple channel ids can be used separated by comma ','.
pingme telegram --token "0125:AAFHvnYf_ABC" --msg "This is a new message ✈" --channel="-1001001001,-1002002001"
```
- Github Action
- GitHub Action
```yaml
on: [push]
@ -37,8 +37,8 @@ jobs:
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_CHANNELS: ${{ secrets.TELEGRAM_CHANNELS }}
TELEGRAM_TITLE: 'Refrence: ${{ github.ref }}'
TELEGRAM_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
TELEGRAM_TITLE: 'Reference: ${{ github.ref }}'
TELEGRAM_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
@ -88,8 +88,8 @@ jobs:
ROCKETCHAT_SERVER_URL: ${{ secrets.ROCKETCHAT_SERVER_URL }}
ROCKETCHAT_CHANNELS: ${{ secrets.ROCKETCHAT_CHANNELS }}
ROCKETCHAT_URL_SCHEME: "https"
ROCKETCHAT_TITLE: 'Refrence: ${{ github.ref }}'
ROCKETCHAT_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
ROCKETCHAT_TITLE: 'Reference: ${{ github.ref }}'
ROCKETCHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
@ -114,7 +114,7 @@ jobs:
pingme pushover --token '123' --user '12345567' --title 'some title' --msg 'some message'
```
- Github Action
- GitHub Action
```yaml
on: [push]
@ -132,8 +132,8 @@ jobs:
env:
PUSHOVER_TOKEN: ${{ secrets.PUSHOVER_TOKEN }}
PUSHOVER_USER: ${{ secrets.PUSHOVER_USER }}
PUSHOVER_TITLE: 'Refrence: ${{ github.ref }}'
PUSHOVER_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
PUSHOVER_TITLE: 'Reference: ${{ github.ref }}'
PUSHOVER_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
@ -161,7 +161,7 @@ You can specify multiple channels by separating the value with ','.
pingme mattermost --token '123' --channel '12345,567' --url 'localhost' --scheme 'http' --msg 'some message'
```
- Github Action
- GitHub Action
```yaml
on:
@ -179,11 +179,11 @@ jobs:
uses: kha7iq/pingme-action@v1
env:
MATTERMOST_TOKEN: ${{ secrets.MATTERMOST_TOKEN }}
ROCKETCHAT_SERVER_URL: ${{ secrets.ROCKETCHAT_SERVER_URL }}
MATTERMOST_SERVER_URL: ${{ secrets.MATTERMOST_SERVER_URL }}
MATTERMOST_CHANNELS: ${{ secrets.MATTERMOST_CHANNELS }}
MATTERMOST_CHANNELS: ${{ secrets.MATTERMOST_CHANNELS }}
MATTERMOST_TITLE: 'Refrence: ${{ github.ref }}'
MATTERMOST_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
MATTERMOST_TITLE: 'Reference: ${{ github.ref }}'
MATTERMOST_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
@ -227,10 +227,10 @@ jobs:
- name: Ping me On
uses: kha7iq/pingme-action@v1
env:
PUSHOVER_TOKEN: ${{ secrets.SLACK_TOKEN }}
SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
SLACK_CHANNELS: ${{ secrets.SLACK_CHANNELS }}
SLACK_MSG_TITLE: 'Refrence: ${{ github.ref }}'
SLACK_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
SLACK_MSG_TITLE: 'Reference: ${{ github.ref }}'
SLACK_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email
@ -254,7 +254,7 @@ Multiple channel ids can be used separated by comma ','.
pingme discord --token '123' --channel '1234567890' --msg 'some message'
```
- Github Action
- GitHub Action
```yaml
on:
@ -273,8 +273,8 @@ jobs:
env:
DISCORD_CHANNELS: ${{ secrets.DISCORD_CHANNELS }}
DISCORD_TOKEN: ${{ secrets.DISCORD_TOKEN }}
DISCORD_TITLE: 'Refrence: ${{ github.ref }}'
DISCORD_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
DISCORD_TITLE: 'Reference: ${{ github.ref }}'
DISCORD_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
@ -298,7 +298,7 @@ you can add permissions for multiple channels to single webhook.
pingme teams --webhook 'https://example.webhook.office.com/xx' --msg 'some message'
```
- Github Action
- GitHub Action
```yaml
on: [push]
@ -315,9 +315,8 @@ jobs:
uses: kha7iq/pingme-action@v1
env:
TEAMS_WEBHOOK: ${{ secrets.TEAMS_WEBHOOK }}
TELEGRAM_CHANNELS: ${{ secrets.TELEGRAM_CHANNELS }}
TEAMS_MSG_TITLE: 'Refrence: ${{ github.ref }}'
TEAMS_MESSAGE: 'Event is triggerd by ${{ github.event_name }}'
TEAMS_MSG_TITLE: 'Reference: ${{ github.ref }}'
TEAMS_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
@ -332,6 +331,56 @@ jobs:
| TEAMS_MESSAGE | "" |
| TEAMS_MSG_TITLE | "" |
## Pushbullet
- SMS
```bash
pingme pushbullet --sms true --token "abcdefg" -d "adnroid" --msg "some message" --number "00123456789"
```
- Push notification
```bash
pingme pushbullet --token "abcdefg" -d "adnroid" --msg "some message"
```
- GitHub Action
```yaml
on: [push]
jobs:
pingme-job:
runs-on: ubuntu-latest
name: PingMe
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Ping me On
uses: kha7iq/pingme-action@v1
env:
PUSHBULLET_TOKEN: ${{ secrets.PUSHBULLET_TOKEN }}
PUSHBULLET_DEVICE: ${{ secrets.PUSHBULLET_DEVICE }}
PUSHBULLET_TITLE: 'Reference: ${{ github.ref }}'
PUSHBULLET_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email
service: pushbullet
```
- **Variables**
| Variables | Default Value |
| -------------------------- | :----------------: |
| PUSHBULLET_TOKEN | "" |
| PUSHBULLET_DEVICE | "" |
| PUSHBULLET_NUMBER | "" |
| PUSHBULLET_MESSAGE | "" |
| PUSHBULLET_SMS | "false" |
| PUSHBULLET_TITLE | "" |
## Email
Email uses username & password to authenticate for sending emails.