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

docs: ✅ Markdown lint

Browse Source 
Fix all markdown documents
This commit is contained in:
Igor Bronovskyi 2021-05-07 10:15:48 +03:00
parent 5a94dd9048
commit ddb40b6751
No known key found for this signature in database
GPG Key ID: A2728F1A703F20E6
12 changed files with 318 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,3 +1,6 @@
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD036 -->
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
@ -5,10 +8,12 @@ about: Create a report to help us improve
--- ---
**Describe the bug** **Describe the bug**
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
**To Reproduce** **To Reproduce**
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
3. Scroll down to '....' 3. Scroll down to '....'
@ -21,15 +26,17 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):** **Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari] - OS: [e.g. iOS]
- Version [e.g. 22] - Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):** **Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1] - Device: [e.g. iPhone6]
- Browser [e.g. stock browser, safari] - OS: [e.g. iOS8.1]
- Version [e.g. 22] - Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context** **Additional context**
Add any other context about the problem here. Add any other context about the problem here.

3
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -1,3 +1,6 @@
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD036 -->
--- ---
name: Feature request name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project

4
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -13,14 +13,14 @@ Please delete options that are not relevant.
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update - [ ] This change requires a documentation update
# How Has This Been Tested? ## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
- [ ] Running existing tests - [ ] Running existing tests
- [ ] Created new tests - [ ] Created new tests
# Checklist: ## Checklist
- [ ] My code has been linted (`make lint`) - [ ] My code has been linted (`make lint`)
- [ ] I have performed a self-review of my own code - [ ] I have performed a self-review of my own code

6
CODE_OF_CONDUCT.md
View File

@ -67,10 +67,10 @@ members of the project's leadership.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, This Code of Conduct is adapted from the [Contributor Covenant][homepage],
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq <https://www.contributor-covenant.org/faq>

41
CONTRIBUTING.md
View File

@ -1,4 +1,5 @@
## Contributing to PingMe # Contributing to PingMe
We want to make contributing to this project as easy and transparent as We want to make contributing to this project as easy and transparent as
possible. possible.
@ -13,26 +14,30 @@ possible.
- `service/telegram` - Telegram notification service. - `service/telegram` - Telegram notification service.
- `service/pushover` - Pushover Notification service. - `service/pushover` - Pushover Notification service.
- Documentation ### Documentation
`docs` - Contains the documentation in Markdown format.
- `docs` - Contains the documentation in Markdown format.
- `services.md` If you are adding a new service please add documentation to `services.md`. - `services.md` If you are adding a new service please add documentation to `services.md`.
- `home.md` Is the main page rendered when docs website is loaded. - `home.md` Is the main page rendered when docs website is loaded.
- `install.md` Contains the installation instructions for different packages. - `install.md` Contains the installation instructions for different packages.
- Checking Locally ### Checking Locally
- Docsify is used for documentation rendering from markdown, you can download
the cli and test locally before opening a pull request.
Install Docsify is used for documentation rendering from markdown, you can download
```bash the cli and test locally before opening a pull request.
npm i docsify-cli -g
# yarn global add docsify-cli
```
Serve locally
```bash
docsify serve docs
```
### Install
```bash
npm i docsify-cli -g
# yarn global add docsify-cli
```
### Serve locally
```bash
docsify serve docs
```
## Commits ## Commits
@ -43,7 +48,8 @@ are using Conventional Commits.
<type>[<scope>]: <short summary> <type>[<scope>]: <short summary>
│ │ │ │ │ │
│ │ └─> Summary in present tense. Not capitalized. No period at the end. │ │ └─> Summary in present tense. Not capitalized. No
| | period at the end.
│ │ │ │
│ └─> Scope (optional): eg. common, compiler, authentication, core │ └─> Scope (optional): eg. common, compiler, authentication, core
│ │
@ -55,6 +61,7 @@ You can follow the documentation on
[their website](https://www.conventionalcommits.org). [their website](https://www.conventionalcommits.org).
## Pull Requests ## Pull Requests
We actively welcome your pull requests. We actively welcome your pull requests.
1. Fork the repo and create your branch from `master`. 1. Fork the repo and create your branch from `master`.
@ -65,9 +72,11 @@ We actively welcome your pull requests.
6. Make sure your code is well formatted (`make fmt`). 6. Make sure your code is well formatted (`make fmt`).
## Issues ## Issues
We use GitHub issues to track public bugs. Please ensure your description is We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue. clear and has sufficient instructions to be able to reproduce the issue.
## License ## License
By contributing to PingMe, you agree that your contributions will be licensed By contributing to PingMe, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree. under the LICENSE file in the root directory of this source tree.

1
LICENSE.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable MD041 -->
MIT License MIT License
Copyright (c) 2021 Khaliq Copyright (c) 2021 Khaliq

70
README.md
View File

@ -1,3 +1,5 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable-next-line -->
<h2 align="center"> <h2 align="center">
<br> <br>
<p align="center"><img width=30% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p> <p align="center"><img width=30% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p>
@ -13,7 +15,6 @@
<a href="#"> <a href="#">
<img alt="Build" src="https://img.shields.io/github/workflow/status/kha7iq/pingme/goreleaser"> <img alt="Build" src="https://img.shields.io/github/workflow/status/kha7iq/pingme/goreleaser">
<a href="https://github.com/kha7iq/pingme/issues"> <a href="https://github.com/kha7iq/pingme/issues">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/kha7iq/pingme?style=flat-square&logo=github&logoColor=white"> <img alt="GitHub issues" src="https://img.shields.io/github/issues/kha7iq/pingme?style=flat-square&logo=github&logoColor=white">
<a href="https://github.com/kha7iq/pingme/blob/master/LICENSE.md"> <a href="https://github.com/kha7iq/pingme/blob/master/LICENSE.md">
<img alt="License" src="https://img.shields.io/github/license/kha7iq/pingme"> <img alt="License" src="https://img.shields.io/github/license/kha7iq/pingme">
@ -37,18 +38,20 @@
## About ## About
**PingMe** is a personal project to satisfy my needs of having alerts, most major platforms have integration to send alerts **PingMe** is a personal project to satisfy my needs of having alerts, most
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 major platforms have integration to send alerts but its not always useful,
which i can just call from my backup scripts, cron jobs, CI/CD pipelines or from anywhere to send a message with particular information. either you are stuck with one particular platform, or you have to do alot of
And i can ship it everywhere with ease. integrations. I needed a small app which i can just call from my backup scripts,
Hence, the birth of PingMe. 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.
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.
## Supported services ## Supported services
- *Discord* - *Discord*
- *Email* - *Email*
- *Microsoft Teams* - *Microsoft Teams*
@ -63,11 +66,13 @@ as message, and most of all this serves as a swiss army knife sort of tool which
## Install ## Install
### MacOS & Linux Homebrew ### MacOS & Linux Homebrew
```bash ```bash
brew install kha7iq/tap/pingme brew install kha7iq/tap/pingme
``` ```
## Linux Binary ## Linux Binary
```bash ```bash
wget -q https://github.com/kha7iq/pingme/releases/download/v0.1.6/pingme_Linux_x86_64.tar.gz 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 tar -xf pingme_Linux_x86_64.tar.gz
@ -76,44 +81,55 @@ sudo mv pingme /usr/local/bin/pingme
``` ```
### Go Get ### Go Get
```bash ```bash
go get -u github.com/kha7iq/pingme go get -u github.com/kha7iq/pingme
``` ```
### Windows ### Windows
```powershell ```powershell
scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git
scoop install pingme scoop install pingme
``` ```
Alternatively you can head over to [release pages](https://github.com/kha7iq/pingme/releases) and download the binary for windows & all other supported platforms. Alternatively you can head over to [release pages](https://github.com/kha7iq/pingme/releases)
and download the binary for windows & all other supported platforms.
### Docker ### Docker
Docker container is also available on both dockerhub and github container registry. Docker container is also available on both dockerhub and github container registry.
`latest` tage will always pull the latest version avaialbe, you can also download specific version. `latest` tage will always pull the latest version avaialbe, you can also download
Checkout [release](https://github.com/kha7iq/pingme/releases) page for available versions. specific version. Checkout [release](https://github.com/kha7iq/pingme/releases)
page for available versions.
Docker Registry Docker Registry
```bash ```bash
docker pull khaliq/pingme:latest docker pull khaliq/pingme:latest
``` ```
Github Registry Github Registry
```bash ```bash
docker pull ghcr.io/kha7iq/pingme:latest docker pull ghcr.io/kha7iq/pingme:latest
``` ```
Run Run
```bash ```bash
docker run ghcr.io/kha7iq/pingme:latest 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. 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. Usage examples for workflow are available in the repo.
## Usage ## Usage
```bash ```bash
@ -126,10 +142,11 @@ USAGE:
main [global options] command [command options] [arguments...] main [global options] command [command options] [arguments...]
DESCRIPTION: DESCRIPTION:
PingMe is a CLI tool which provides the ability to send messages or alerts to multiple PingMe is a CLI tool which provides the ability to send messages or alerts
messaging platforms and also email, everything is configurable via environment to multiple messaging platforms and also email, everything is configurable
variables and command line switches.Currently supported platforms include Slack, Telegram, via environment variables and command line switches.Currently supported
RocketChat, Discord, Pushover, Mattermost, Microsoft Teams and email address. platforms include Slack, Telegram, RocketChat, Discord, Pushover, Mattermost,
Microsoft Teams and email address.
COMMANDS: COMMANDS:
telegram Send message to telegram telegram Send message to telegram
@ -151,16 +168,17 @@ Check [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
## Configuration ## Configuration
All the flags have corresponding environment variables associated with it. You can either provide the value with flags All the flags have corresponding environment variables associated with it. You
or export to a variable. can either provide the value with flags or export to a variable.
View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more
details.
## Contributing ## Contributing
Contributions, issues and feature requests are welcome!<br/>Feel free to check [issues page](https://github.com/kha7iq/pingme/issues). You can also take a look at the [contributing guide](https://github.com/kha7iq/pingme/blob/master/CONTRIBUTING.md). Contributions, issues and feature requests are welcome!<br/>Feel free to check
[issues page](https://github.com/kha7iq/pingme/issues). You can also take a look
at the [contributing guide](https://github.com/kha7iq/pingme/blob/master/CONTRIBUTING.md).
## Show your support ## Show your support

1
docs/_sidebar.md
View File

@ -1,4 +1,5 @@
<!-- docs/_sidebar.md --> <!-- docs/_sidebar.md -->
<!-- markdownlint-disable MD041 -->
* [Home](/) * [Home](/)
* [Installation](install.md) * [Installation](install.md)

41
docs/contribution.md
View File

@ -1,4 +1,5 @@
## Contributing to PingMe # Contributing to PingMe
We want to make contributing to this project as easy and transparent as We want to make contributing to this project as easy and transparent as
possible. possible.
@ -13,26 +14,30 @@ possible.
- `service/telegram` - Telegram notification service. - `service/telegram` - Telegram notification service.
- `service/pushover` - Pushover Notification service. - `service/pushover` - Pushover Notification service.
- Documentation ### Documentation
`docs` - Contains the documentation in Markdown format.
- `docs` - Contains the documentation in Markdown format.
- `services.md` If you are adding a new service please add documentation to `services.md`. - `services.md` If you are adding a new service please add documentation to `services.md`.
- `home.md` Is the main page rendered when docs website is loaded. - `home.md` Is the main page rendered when docs website is loaded.
- `install.md` Contains the installation instructions for different packages. - `install.md` Contains the installation instructions for different packages.
- Checking Locally ### Checking Locally
- Docsify is used for documentation rendering from markdown, you can download
the cli and test locally before opening a pull request.
Install Docsify is used for documentation rendering from markdown, you can download the
```bash cli and test locally before opening a pull request.
npm i docsify-cli -g
# yarn global add docsify-cli
```
Serve locally
```bash
docsify serve docs
```
### Install
```bash
npm i docsify-cli -g
# yarn global add docsify-cli
```
### Serve locally
```bash
docsify serve docs
```
## Commits ## Commits
@ -43,7 +48,8 @@ are using Conventional Commits.
<type>[<scope>]: <short summary> <type>[<scope>]: <short summary>
│ │ │ │ │ │
│ │ └─> Summary in present tense. Not capitalized. No period at the end. │ │ └─> Summary in present tense. Not capitalized. No
| | period at the end.
│ │ │ │
│ └─> Scope (optional): eg. common, compiler, authentication, core │ └─> Scope (optional): eg. common, compiler, authentication, core
│ │
@ -55,6 +61,7 @@ You can follow the documentation on
[their website](https://www.conventionalcommits.org). [their website](https://www.conventionalcommits.org).
## Pull Requests ## Pull Requests
We actively welcome your pull requests. We actively welcome your pull requests.
1. Fork the repo and create your branch from `master`. 1. Fork the repo and create your branch from `master`.
@ -65,9 +72,11 @@ We actively welcome your pull requests.
6. Make sure your code is well formatted (`make fmt`). 6. Make sure your code is well formatted (`make fmt`).
## Issues ## Issues
We use GitHub issues to track public bugs. Please ensure your description is We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue. clear and has sufficient instructions to be able to reproduce the issue.
## License ## License
By contributing to PingMe, you agree that your contributions will be licensed By contributing to PingMe, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree. under the LICENSE file in the root directory of this source tree.

39
docs/home.md
View File

@ -1,3 +1,5 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable-next-line -->
<h2 align="center"> <h2 align="center">
<br> <br>
<p align="center"><img width=20% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p> <p align="center"><img width=20% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p>
@ -32,17 +34,20 @@
## About ## About
**PingMe** is a personal project to satisfy my needs of having alerts, most major platforms have integration to send alerts **PingMe** is a personal project to satisfy my needs of having alerts, most
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 major platforms have integration to send alerts but it's not always useful,
which i can just call from my backup scripts, cron jobs, CI/CD pipelines or from anywhere to send a message with particular information. either you are stuck with one particular platform, or you have to do alot of
And i can ship it everywhere with ease. integrations. I needed a small app which i can just call from my backup scripts,
Hence, the birth of PingMe. 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.
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.
## Supported services ## Supported services
- *Discord* - *Discord*
- *Email* - *Email*
- *Microsoft Teams* - *Microsoft Teams*
@ -54,26 +59,26 @@ as message, and most of all this serves as a swiss army knife sort of tool which
- *Telegram* - *Telegram*
- *Twillio* - *Twillio*
## Demo ## Demo
![Demo](https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/pingme.gif)
![Demo](https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/pingme.gif)
## Contributing ## Contributing
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/kha7iq/pingme/issues). You can also take a look at the [contribution guide](contribution.md). Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/kha7iq/pingme/issues).
You can also take a look at the [contribution guide](contribution.md).
## Show your support ## Show your support
Give a ⭐️ if you like this project! Give a ⭐️ if you like this project!
## Disclaimer ## Disclaimer
Any misuse of this utility is your own liability and responsibility and cannot be attributed to the authors of this library. See [license](https://github.com/kha7iq/pingme/blob/master/LICENSE.md) for more. Any misuse of this utility is your own liability and responsibility and cannot
be attributed to the authors of this library. See
[license](https://github.com/kha7iq/pingme/blob/master/LICENSE.md) for more.
Spamming through the use of this library **may get you permanently banned** on most supported platforms. Spamming through the use of this library **may get you permanently banned** on
most supported platforms.

27
docs/install.md
View File

@ -1,10 +1,13 @@
# Installation
## MacOS & Linux Homebrew ## MacOS & Linux Homebrew
```bash ```bash
brew install kha7iq/tap/pingme brew install kha7iq/tap/pingme
``` ```
## Linux Binary ## Linux Binary
```bash ```bash
wget -q https://github.com/kha7iq/pingme/releases/download/v0.1.6/pingme_Linux_x86_64.tar.gz 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 tar -xf pingme_Linux_x86_64.tar.gz
@ -13,41 +16,51 @@ sudo mv pingme /usr/local/bin/pingme
``` ```
## Go Get ## Go Get
```bash ```bash
go get -u github.com/kha7iq/pingme go get -u github.com/kha7iq/pingme
``` ```
## Windows ## Windows
```powershell ```powershell
scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git
scoop install pingme scoop install pingme
``` ```
Alternatively you can head over to [release pages](https://github.com/kha7iq/pingme/releases) and download the binary for windows & all other supported platforms. Alternatively you can head over to [release pages](https://github.com/kha7iq/pingme/releases)
and download the binary for windows & all other supported platforms.
## Docker ## Docker
Docker container is also available on both dockerhub and github container registry. Docker container is also available on both dockerhub and github container registry.
`latest` tage will always pull the latest version avaialbe, you can also download specific version. `latest` tage will always pull the latest version avaialbe, you can also
Checkout [release](https://github.com/kha7iq/pingme/releases) page for available versions. download specific version. Checkout [release](https://github.com/kha7iq/pingme/releases)
page for available versions.
- Docker Registry - Docker Registry
```bash ```bash
docker pull khaliq/pingme:latest docker pull khaliq/pingme:latest
``` ```
- GitHub Registry - GitHub Registry
```bash ```bash
docker pull ghcr.io/kha7iq/pingme:latest docker pull ghcr.io/kha7iq/pingme:latest
``` ```
- Run - Run
```bash ```bash
docker run ghcr.io/kha7iq/pingme:latest 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.
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. Usage examples for workflow are available in the repo.

264
docs/services.md
View File

@ -1,17 +1,15 @@
# Configuration
All the flags have crosponding enviornment variables assosiated with it. You
### Configuration can either provide the value with flags or export to a variable. You can view
the crosponding variable to each with --help flag.
All the flags have crosponding enviornment variables assosiated with it. You can either provide the value with flags
or export to a variable. You can view the crosponding variable to each with --help flag.
*Flags* take presedance over *variables* *Flags* take presedance over *variables*
*Default* value for message title is current *time* *Default* value for message title is current *time*
## Telegram ## Telegram
Telegram uses bot token to authenticate & send messages to defined channels. Telegram uses bot token to authenticate & send messages to defined channels.
Multiple channel ids can be used separated by comma ','. Multiple channel ids can be used separated by comma ','.
@ -45,25 +43,30 @@ jobs:
# slack / telegram / rocketchat / teams / pushover / discord / email # slack / telegram / rocketchat / teams / pushover / discord / email
service: telegram service: telegram
``` ```
- **Variables** - **Variables**
| Variables | Default Value |
| Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| TELEGRAM_MSG_TITLE | "" | | TELEGRAM_MSG_TITLE | "" |
| TELEGRAM_TOKEN | "" | | TELEGRAM_TOKEN | "" |
| TELEGRAM_CHANNELS | "" | | TELEGRAM_CHANNELS | "" |
| TELEGRAM_MESSAGE | "" | | TELEGRAM_MESSAGE | "" |
| TELEGRAM_MSG_TITLE | "" | | TELEGRAM_MSG_TITLE | "" |
## RocketChat ## RocketChat
RocketChat uses token & userID to authenticate and send messages to defined channels.
Multiple channel ids can be used separated by comma ','. RocketChat uses token & userID to authenticate and send messages to defined
channels. Multiple channel ids can be used separated by comma ','.
```bash ```bash
pingme rocketchat --channel "general,Pingme" --msg ":wave: rocketchat from cli" --userid "123" --token "abcxyz" \ pingme rocketchat \
--url 'localhost:3000' --scheme "http" --channel "general,Pingme" \
--msg ":wave: rocketchat from cli" \
--userid "123" \
--token "abcxyz" \
--url 'localhost:3000' \
--scheme "http"
``` ```
- Github Action - Github Action
@ -92,26 +95,31 @@ jobs:
ROCKETCHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}' ROCKETCHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost # slack / telegram / rocketchat / teams /
# pushover / discord / email / mattermost
service: rocketchat service: rocketchat
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| ROCKETCHAT_USERID | "" | | ROCKETCHAT_USERID | "" |
| ROCKETCHAT_TOKEN | "" | | ROCKETCHAT_TOKEN | "" |
| ROCKETCHAT_SERVER_URL | "" | | ROCKETCHAT_SERVER_URL | "" |
| ROCKETCHAT_URL_SCHEME | "https" | | ROCKETCHAT_URL_SCHEME | "https" |
| RTOCKETCHAT_MESSAGE | "" | | RTOCKETCHAT_MESSAGE | "" |
| ROCKETCHAT_TITLE | "" | | ROCKETCHAT_TITLE | "" |
| ROCKETCHAT_CHANNELS | "" | | ROCKETCHAT_CHANNELS | "" |
## Pushover ## Pushover
```bash ```bash
pingme pushover --token '123' --user '12345567' --title 'some title' --msg 'some message' pingme pushover \
--token '123' \
--user '12345567' \
--title 'some title' \
--msg 'some message'
``` ```
- GitHub Action - GitHub Action
@ -137,28 +145,35 @@ jobs:
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email # slack / telegram / rocketchat / teams /
# pushover / discord / email
service: pushover service: pushover
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| PUSHOVER_TOKEN | "" | | PUSHOVER_TOKEN | "" |
| PUSHOVER_USER | "" | | PUSHOVER_USER | "" |
| PUSHOVER_MESSAGE | "" | | PUSHOVER_MESSAGE | "" |
| PUSHOVER_TITLE | "" | | PUSHOVER_TITLE | "" |
## Mattermost ## Mattermost
Mattermost uses token to authenticate and channel ids for targets.
Destination server can be specified as 'example.com' by default the 'https' is used, you Mattermost uses token to authenticate and channel ids for targets. Destination
can change this with --scheme flag and set it to 'http'. server can be specified as 'example.com' by default the 'https' is used, you
Latest api version 4 is used for interacting with server, this can also be changes with --api flag. can change this with --scheme flag and set it to 'http'. Latest api version 4
is used for interacting with server, this can also be changes with --api flag.
You can specify multiple channels by separating the value with ','. You can specify multiple channels by separating the value with ','.
```bash ```bash
pingme mattermost --token '123' --channel '12345,567' --url 'localhost' --scheme 'http' --msg 'some message' pingme mattermost \
--token '123' \
--channel '12345,567' \
--url 'localhost' \
--scheme 'http' \
--msg 'some message'
``` ```
- GitHub Action - GitHub Action
@ -186,28 +201,33 @@ jobs:
MATTERMOST_MESSAGE: 'Event is triggered by ${{ github.event_name }}' MATTERMOST_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost # slack / telegram / rocketchat / teams /
# pushover / discord / email / mattermost
service: mattermost service: mattermost
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| MATTERMOST_API_URL | "/api/v4/posts" | | MATTERMOST_API_URL | "/api/v4/posts" |
| MATTERMOST_TOKEN | "" | | MATTERMOST_TOKEN | "" |
| MATTERMOST_SERVER_URL | "" | | MATTERMOST_SERVER_URL | "" |
| MATTERMOST_SCHEME | "https" | | MATTERMOST_SCHEME | "https" |
| MATTERMOST_MESSAGE | "" | | MATTERMOST_MESSAGE | "" |
| MATTERMOST_TITLE | "" | | MATTERMOST_TITLE | "" |
| MATTERMOST_CHANNELS | "" | | MATTERMOST_CHANNELS | "" |
## Slack ## Slack
Slack uses token to authenticate and send messages to defined channels. Slack uses token to authenticate and send messages to defined channels.
Multiple channel ids can be used separated by comma ','. Multiple channel ids can be used separated by comma ','.
```bash ```bash
pingme slack --token '123' --channel '1234567890' --msg 'some message' pingme slack \
--token '123' \
--channel '1234567890' \
--msg 'some message'
``` ```
- Github Action - Github Action
@ -233,20 +253,21 @@ jobs:
SLACK_MESSAGE: 'Event is triggered by ${{ github.event_name }}' SLACK_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email # slack / telegram / rocketchat / teams /
# pushover / discord / email
service: slack service: slack
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| SLACK_TOKEN | "" | | SLACK_TOKEN | "" |
| SLACK_CHANNELS | "" | | SLACK_CHANNELS | "" |
| SLACK_MESSAGE | "" | | SLACK_MESSAGE | "" |
## Discord ## Discord
Discord uses bot token to authenticate & send messages to defined channels. Discord uses bot token to authenticate & send messages to defined channels.
Multiple channel ids can be used separated by comma ','. Multiple channel ids can be used separated by comma ','.
@ -277,22 +298,24 @@ jobs:
DISCORD_MESSAGE: 'Event is triggered by ${{ github.event_name }}' DISCORD_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost # slack / telegram / rocketchat / teams /
# pushover / discord / email / mattermost
service: discord service: discord
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| DISCORD_TOKEN | "" | | DISCORD_TOKEN | "" |
| DISCORD_CHANNELS | "" | | DISCORD_CHANNELS | "" |
| DISCORD_MESSAGE | "" | | DISCORD_MESSAGE | "" |
| DISCORD_MSG_TITLE | "" | | DISCORD_MSG_TITLE | "" |
## Microsoft Teams ## Microsoft Teams
Teams uses webhooks to send messages, you can add multiple webhooks separated by comma ',' or
you can add permissions for multiple channels to single webhook. Teams uses webhooks to send messages, you can add multiple webhooks separated
by comma ',' or you can add permissions for multiple channels to single webhook.
```bash ```bash
pingme teams --webhook 'https://example.webhook.office.com/xx' --msg 'some message' pingme teams --webhook 'https://example.webhook.office.com/xx' --msg 'some message'
@ -320,25 +343,34 @@ jobs:
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost # slack / telegram / rocketchat / teams /
# pushover / discord / email / mattermost
service: teams service: teams
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| TEAMS_WEBHOOK | "" | | TEAMS_WEBHOOK | "" |
| TEAMS_MESSAGE | "" | | TEAMS_MESSAGE | "" |
| TEAMS_MSG_TITLE | "" | | TEAMS_MSG_TITLE | "" |
## Pushbullet ## Pushbullet
- SMS - SMS
```bash ```bash
pingme pushbullet --sms true --token "abcdefg" -d "adnroid" --msg "some message" --number "00123456789" pingme pushbullet \
--sms true \
--token "abcdefg" \
-d "adnroid" \
--msg "some message" \
--number "00123456789"
``` ```
- Push notification - Push notification
```bash ```bash
pingme pushbullet --token "abcdefg" -d "adnroid" --msg "some message" pingme pushbullet --token "abcdefg" -d "adnroid" --msg "some message"
``` ```
@ -366,28 +398,34 @@ jobs:
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email # slack / telegram / rocketchat / teams /
# pushover / discord / email
service: pushbullet service: pushbullet
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| PUSHBULLET_TOKEN | "" | | PUSHBULLET_TOKEN | "" |
| PUSHBULLET_DEVICE | "" | | PUSHBULLET_DEVICE | "" |
| PUSHBULLET_NUMBER | "" | | PUSHBULLET_NUMBER | "" |
| PUSHBULLET_MESSAGE | "" | | PUSHBULLET_MESSAGE | "" |
| PUSHBULLET_SMS | "false" | | PUSHBULLET_SMS | "false" |
| PUSHBULLET_TITLE | "" | | PUSHBULLET_TITLE | "" |
## Twillio SMS ## Twillio SMS
SMS can be sent via twillio to multiple numbers, you can add multiple receivers separated by a comma.
SMS can be sent via twillio to multiple numbers, you can add multiple receivers
separated by a comma.
```bash ```bash
pingme twillio --token 'tokenabc' --account 'sid123' --sender '+140001442' --receiver '+140001442'' --msg 'some message' pingme twillio \
--token 'tokenabc' \
--account 'sid123' \
--sender '+140001442' \
--receiver '+140001442' \
--msg 'some message'
``` ```
- GitHub Action - GitHub Action
@ -414,40 +452,50 @@ jobs:
TWILLIO_MESSAGE: 'Event is triggered by ${{ github.event_name }}' TWILLIO_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with: with:
# Chose the messaging platform. # Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost / twillio # slack / telegram / rocketchat / teams /
# pushover / discord / email / mattermost / twillio
service: twillio service: twillio
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| TWILLIO_TOKEN | "" | | TWILLIO_TOKEN | "" |
| TWILLIO_ACCOUNT_SID | "" | | TWILLIO_ACCOUNT_SID | "" |
| TWILLIO_SENDER | "" | | TWILLIO_SENDER | "" |
| TWILLIO_RECEIVER | "" | | TWILLIO_RECEIVER | "" |
| TWILLIO_TITLE | "" | | TWILLIO_TITLE | "" |
| TWILLIO_MESSAGE | "" | | TWILLIO_MESSAGE | "" |
## Email ## Email
Email uses username & password to authenticate for sending emails.
SMTP hostname i.e smtp.gmail.com and port i.e (587) should be provided as well for the server. Email uses username & password to authenticate for sending emails. SMTP
Multiple email ids can be used separated by comma ',' as receiver email address. hostname i.e smtp.gmail.com and port i.e (587) should be provided as well for
All configuration options are also available via environment variables check configuration section. the server. Multiple email ids can be used separated by comma ',' as receiver
email address. All configuration options are also available via environment
variables check configuration section.
```bash ```bash
pingme email --rec "example@gmail.com,example@outlook.com" --msg "This is an email from PingMe CLI" --sub "Email from PingMe CLI" \ pingme email \
--sender "sender@gmail.com" --host "smtp.gmail.com" --port "587" --pass "secretPassword" --rec "example@gmail.com,example@outlook.com" \
--msg "This is an email from PingMe CLI" \
--sub "Email from PingMe CLI" \
--sender "sender@gmail.com" \
--host "smtp.gmail.com" \
--port "587" \
--pass "secretPassword"
``` ```
- **Variables** - **Variables**
| Variables | Default Value | | Variables | Default Value |
| -------------------------- | :----------------: | | -------------------------- | :----------------: |
| EMAIL_SENDER | "" | | EMAIL_SENDER | "" |
| EMAIL_PASSWORD | "" | | EMAIL_PASSWORD | "" |
| EMAIL_RECEIVER | "" | | EMAIL_RECEIVER | "" |
| EMAIL_IDENTITY | "" | | EMAIL_IDENTITY | "" |
| EMAIL_HOST | "smtp.gmail.com" | | EMAIL_HOST | "smtp.gmail.com" |
| EMAIL_PORT | "587" | | EMAIL_PORT | "587" |
| EMAIL_MESSAGE | "" | | EMAIL_MESSAGE | "" |
| EMAIL_SUBJECT | "" | | EMAIL_SUBJECT | "" |