mirror of
https://github.com/kha7iq/pingme.git
synced 2025-05-15 06:10:12 -07:00
docs: ✅ Markdown lint
Fix all markdown documents
This commit is contained in:
Igor Bronovskyi
parent
5a94dd9048
commit
ddb40b6751
21
.github/ISSUE_TEMPLATE/bug_report.md
vendored
21
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,3 +1,6 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
@ -5,10 +8,12 @@ about: Create a report to help us improve
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
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.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
3
.github/ISSUE_TEMPLATE/feature_request.md
vendored
3
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,3 +1,6 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
|
||||
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -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)
|
||||
- [ ] 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
|
||||
|
||||
- [ ] Running existing tests
|
||||
- [ ] Created new tests
|
||||
|
||||
# Checklist:
|
||||
## Checklist
|
||||
|
||||
- [ ] My code has been linted (`make lint`)
|
||||
- [ ] I have performed a self-review of my own code
|
||||
|
||||
@ -67,10 +67,10 @@ members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
<https://www.contributor-covenant.org/faq>
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
## Contributing to PingMe
|
||||
# Contributing to PingMe
|
||||
|
||||
We want to make contributing to this project as easy and transparent as
|
||||
possible.
|
||||
|
||||
@ -13,26 +14,30 @@ possible.
|
||||
- `service/telegram` - Telegram notification service.
|
||||
- `service/pushover` - Pushover Notification service.
|
||||
|
||||
- Documentation
|
||||
`docs` - Contains the documentation in Markdown format.
|
||||
### Documentation
|
||||
|
||||
- `docs` - Contains the documentation in Markdown format.
|
||||
- `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.
|
||||
- `install.md` Contains the installation instructions for different packages.
|
||||
|
||||
- Checking Locally
|
||||
- Docsify is used for documentation rendering from markdown, you can download
|
||||
the cli and test locally before opening a pull request.
|
||||
### Checking Locally
|
||||
|
||||
Install
|
||||
```bash
|
||||
npm i docsify-cli -g
|
||||
# yarn global add docsify-cli
|
||||
```
|
||||
Serve locally
|
||||
```bash
|
||||
docsify serve docs
|
||||
```
|
||||
Docsify is used for documentation rendering from markdown, you can download
|
||||
the cli and test locally before opening a pull request.
|
||||
|
||||
### Install
|
||||
|
||||
```bash
|
||||
npm i docsify-cli -g
|
||||
# yarn global add docsify-cli
|
||||
```
|
||||
|
||||
### Serve locally
|
||||
|
||||
```bash
|
||||
docsify serve docs
|
||||
```
|
||||
|
||||
## Commits
|
||||
|
||||
@ -43,7 +48,8 @@ are using Conventional Commits.
|
||||
|
||||
<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
|
||||
│
|
||||
@ -55,6 +61,7 @@ You can follow the documentation on
|
||||
[their website](https://www.conventionalcommits.org).
|
||||
|
||||
## Pull Requests
|
||||
|
||||
We actively welcome your pull requests.
|
||||
|
||||
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`).
|
||||
|
||||
## Issues
|
||||
|
||||
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.
|
||||
|
||||
## License
|
||||
|
||||
By contributing to PingMe, you agree that your contributions will be licensed
|
||||
under the LICENSE file in the root directory of this source tree.
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021 Khaliq
|
||||
|
||||
70
README.md
70
README.md
@ -1,3 +1,5 @@
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<!-- markdownlint-disable-next-line -->
|
||||
<h2 align="center">
|
||||
<br>
|
||||
<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="#">
|
||||
<img alt="Build" src="https://img.shields.io/github/workflow/status/kha7iq/pingme/goreleaser">
|
||||
<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">
|
||||
<a href="https://github.com/kha7iq/pingme/blob/master/LICENSE.md">
|
||||
<img alt="License" src="https://img.shields.io/github/license/kha7iq/pingme">
|
||||
@ -37,18 +38,20 @@
|
||||
|
||||
## 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
|
||||
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.
|
||||
|
||||
**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 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.
|
||||
|
||||
## Supported services
|
||||
|
||||
- *Discord*
|
||||
- *Email*
|
||||
- *Microsoft Teams*
|
||||
@ -63,11 +66,13 @@ as message, and most of all this serves as a swiss army knife sort of tool which
|
||||
## Install
|
||||
|
||||
### 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
|
||||
@ -76,44 +81,55 @@ sudo mv pingme /usr/local/bin/pingme
|
||||
```
|
||||
|
||||
### Go Get
|
||||
|
||||
```bash
|
||||
go get -u github.com/kha7iq/pingme
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
```powershell
|
||||
scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git
|
||||
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 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.
|
||||
Checkout [release](https://github.com/kha7iq/pingme/releases) page for available versions.
|
||||
`latest` tage will always pull the latest version avaialbe, you can also download
|
||||
specific version. Checkout [release](https://github.com/kha7iq/pingme/releases)
|
||||
page for available versions.
|
||||
|
||||
Docker Registry
|
||||
|
||||
```bash
|
||||
docker pull khaliq/pingme:latest
|
||||
```
|
||||
|
||||
Github Registry
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/kha7iq/pingme:latest
|
||||
```
|
||||
|
||||
Run
|
||||
|
||||
```bash
|
||||
docker run ghcr.io/kha7iq/pingme:latest
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
```bash
|
||||
@ -126,10 +142,11 @@ USAGE:
|
||||
main [global options] command [command options] [arguments...]
|
||||
|
||||
DESCRIPTION:
|
||||
PingMe is a CLI tool which provides the ability to send messages or alerts to multiple
|
||||
messaging platforms and also email, everything is configurable via environment
|
||||
variables and command line switches.Currently supported platforms include Slack, Telegram,
|
||||
RocketChat, Discord, Pushover, Mattermost, Microsoft Teams and email address.
|
||||
PingMe is a CLI tool which provides the ability to send messages or alerts
|
||||
to multiple messaging platforms and also email, everything is configurable
|
||||
via environment variables and command line switches.Currently supported
|
||||
platforms include Slack, Telegram, RocketChat, Discord, Pushover, Mattermost,
|
||||
Microsoft Teams and email address.
|
||||
|
||||
COMMANDS:
|
||||
telegram Send message to telegram
|
||||
@ -151,16 +168,17 @@ Check [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
|
||||
|
||||
## Configuration
|
||||
|
||||
All the flags have corresponding environment variables associated with it. You can either provide the value with flags
|
||||
or export to a variable.
|
||||
|
||||
View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
|
||||
All the flags have corresponding environment variables associated with it. You
|
||||
can either provide the value with flags or export to a variable.
|
||||
|
||||
View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more
|
||||
details.
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
<!-- docs/_sidebar.md -->
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
|
||||
* [Home](/)
|
||||
* [Installation](install.md)
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
## Contributing to PingMe
|
||||
# Contributing to PingMe
|
||||
|
||||
We want to make contributing to this project as easy and transparent as
|
||||
possible.
|
||||
|
||||
@ -13,26 +14,30 @@ possible.
|
||||
- `service/telegram` - Telegram notification service.
|
||||
- `service/pushover` - Pushover Notification service.
|
||||
|
||||
- Documentation
|
||||
`docs` - Contains the documentation in Markdown format.
|
||||
### Documentation
|
||||
|
||||
- `docs` - Contains the documentation in Markdown format.
|
||||
- `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.
|
||||
- `install.md` Contains the installation instructions for different packages.
|
||||
|
||||
- Checking Locally
|
||||
- Docsify is used for documentation rendering from markdown, you can download
|
||||
the cli and test locally before opening a pull request.
|
||||
### Checking Locally
|
||||
|
||||
Install
|
||||
```bash
|
||||
npm i docsify-cli -g
|
||||
# yarn global add docsify-cli
|
||||
```
|
||||
Serve locally
|
||||
```bash
|
||||
docsify serve docs
|
||||
```
|
||||
Docsify is used for documentation rendering from markdown, you can download the
|
||||
cli and test locally before opening a pull request.
|
||||
|
||||
### Install
|
||||
|
||||
```bash
|
||||
npm i docsify-cli -g
|
||||
# yarn global add docsify-cli
|
||||
```
|
||||
|
||||
### Serve locally
|
||||
|
||||
```bash
|
||||
docsify serve docs
|
||||
```
|
||||
|
||||
## Commits
|
||||
|
||||
@ -43,7 +48,8 @@ are using Conventional Commits.
|
||||
|
||||
<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
|
||||
│
|
||||
@ -55,6 +61,7 @@ You can follow the documentation on
|
||||
[their website](https://www.conventionalcommits.org).
|
||||
|
||||
## Pull Requests
|
||||
|
||||
We actively welcome your pull requests.
|
||||
|
||||
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`).
|
||||
|
||||
## Issues
|
||||
|
||||
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.
|
||||
|
||||
## License
|
||||
|
||||
By contributing to PingMe, you agree that your contributions will be licensed
|
||||
under the LICENSE file in the root directory of this source tree.
|
||||
|
||||
39
docs/home.md
39
docs/home.md
@ -1,3 +1,5 @@
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<!-- markdownlint-disable-next-line -->
|
||||
<h2 align="center">
|
||||
<br>
|
||||
<p align="center"><img width=20% src="https://raw.githubusercontent.com/kha7iq/pingme/master/.github/img/logo.png"></p>
|
||||
@ -32,17 +34,20 @@
|
||||
|
||||
## About
|
||||
|
||||
**PingMe** is a personal project to satisfy my needs of having alerts, most major platforms have integration to send alerts
|
||||
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.
|
||||
**PingMe** is a personal project to satisfy my needs of having alerts, most
|
||||
major platforms have integration to send alerts 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.
|
||||
|
||||
## Supported services
|
||||
|
||||
- *Discord*
|
||||
- *Email*
|
||||
- *Microsoft Teams*
|
||||
@ -54,26 +59,26 @@ as message, and most of all this serves as a swiss army knife sort of tool which
|
||||
- *Telegram*
|
||||
- *Twillio*
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
Give a ⭐️ if you like this project!
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
@ -1,10 +1,13 @@
|
||||
# Installation
|
||||
|
||||
## 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
|
||||
@ -13,41 +16,51 @@ sudo mv pingme /usr/local/bin/pingme
|
||||
```
|
||||
|
||||
## Go Get
|
||||
|
||||
```bash
|
||||
go get -u github.com/kha7iq/pingme
|
||||
```
|
||||
|
||||
|
||||
## Windows
|
||||
|
||||
```powershell
|
||||
scoop bucket add pingme https://github.com/kha7iq/scoop-bucket.git
|
||||
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 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.
|
||||
Checkout [release](https://github.com/kha7iq/pingme/releases) page for available versions.
|
||||
`latest` tage will always pull the latest version avaialbe, you can also
|
||||
download specific version. Checkout [release](https://github.com/kha7iq/pingme/releases)
|
||||
page for available versions.
|
||||
|
||||
- Docker Registry
|
||||
|
||||
```bash
|
||||
docker pull khaliq/pingme:latest
|
||||
```
|
||||
|
||||
- GitHub Registry
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/kha7iq/pingme:latest
|
||||
```
|
||||
|
||||
- Run
|
||||
|
||||
```bash
|
||||
docker run ghcr.io/kha7iq/pingme:latest
|
||||
```
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
138
docs/services.md
138
docs/services.md
@ -1,17 +1,15 @@
|
||||
# Configuration
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
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.
|
||||
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*
|
||||
|
||||
*Default* value for message title is current *time*
|
||||
|
||||
|
||||
## Telegram
|
||||
|
||||
Telegram uses bot token to authenticate & send messages to defined channels.
|
||||
Multiple channel ids can be used separated by comma ','.
|
||||
|
||||
@ -45,8 +43,8 @@ jobs:
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email
|
||||
service: telegram
|
||||
```
|
||||
- **Variables**
|
||||
|
||||
- **Variables**
|
||||
|
||||
| Variables | Default Value |
|
||||
| -------------------------- | :----------------: |
|
||||
@ -56,14 +54,19 @@ jobs:
|
||||
| TELEGRAM_MESSAGE | "" |
|
||||
| TELEGRAM_MSG_TITLE | "" |
|
||||
|
||||
|
||||
## 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
|
||||
pingme rocketchat --channel "general,Pingme" --msg ":wave: rocketchat from cli" --userid "123" --token "abcxyz" \
|
||||
--url 'localhost:3000' --scheme "http"
|
||||
pingme rocketchat \
|
||||
--channel "general,Pingme" \
|
||||
--msg ":wave: rocketchat from cli" \
|
||||
--userid "123" \
|
||||
--token "abcxyz" \
|
||||
--url 'localhost:3000' \
|
||||
--scheme "http"
|
||||
```
|
||||
|
||||
- Github Action
|
||||
@ -92,9 +95,11 @@ jobs:
|
||||
ROCKETCHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email / mattermost
|
||||
service: rocketchat
|
||||
```
|
||||
|
||||
- **Variables**
|
||||
|
||||
| Variables | Default Value |
|
||||
@ -107,11 +112,14 @@ jobs:
|
||||
| ROCKETCHAT_TITLE | "" |
|
||||
| ROCKETCHAT_CHANNELS | "" |
|
||||
|
||||
|
||||
## Pushover
|
||||
|
||||
```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
|
||||
@ -137,7 +145,8 @@ jobs:
|
||||
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email
|
||||
service: pushover
|
||||
```
|
||||
|
||||
@ -151,14 +160,20 @@ jobs:
|
||||
| PUSHOVER_TITLE | "" |
|
||||
|
||||
## 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
|
||||
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.
|
||||
|
||||
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
|
||||
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 ','.
|
||||
|
||||
```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
|
||||
@ -186,7 +201,8 @@ jobs:
|
||||
MATTERMOST_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email / mattermost
|
||||
service: mattermost
|
||||
```
|
||||
|
||||
@ -203,11 +219,15 @@ jobs:
|
||||
| MATTERMOST_CHANNELS | "" |
|
||||
|
||||
## Slack
|
||||
|
||||
Slack uses token to authenticate and send messages to defined channels.
|
||||
Multiple channel ids can be used separated by comma ','.
|
||||
|
||||
```bash
|
||||
pingme slack --token '123' --channel '1234567890' --msg 'some message'
|
||||
pingme slack \
|
||||
--token '123' \
|
||||
--channel '1234567890' \
|
||||
--msg 'some message'
|
||||
```
|
||||
|
||||
- Github Action
|
||||
@ -233,7 +253,8 @@ jobs:
|
||||
SLACK_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email
|
||||
service: slack
|
||||
```
|
||||
|
||||
@ -245,8 +266,8 @@ jobs:
|
||||
| SLACK_CHANNELS | "" |
|
||||
| SLACK_MESSAGE | "" |
|
||||
|
||||
|
||||
## Discord
|
||||
|
||||
Discord uses bot token to authenticate & send messages to defined channels.
|
||||
Multiple channel ids can be used separated by comma ','.
|
||||
|
||||
@ -277,9 +298,11 @@ jobs:
|
||||
DISCORD_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email / mattermost
|
||||
service: discord
|
||||
```
|
||||
|
||||
- **Variables**
|
||||
|
||||
| Variables | Default Value |
|
||||
@ -289,10 +312,10 @@ jobs:
|
||||
| DISCORD_MESSAGE | "" |
|
||||
| DISCORD_MSG_TITLE | "" |
|
||||
|
||||
|
||||
## 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
|
||||
pingme teams --webhook 'https://example.webhook.office.com/xx' --msg 'some message'
|
||||
@ -320,9 +343,11 @@ jobs:
|
||||
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email / mattermost
|
||||
service: teams
|
||||
```
|
||||
|
||||
- **Variables**
|
||||
|
||||
| Variables | Default Value |
|
||||
@ -334,11 +359,18 @@ jobs:
|
||||
## Pushbullet
|
||||
|
||||
- SMS
|
||||
|
||||
```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
|
||||
|
||||
```bash
|
||||
pingme pushbullet --token "abcdefg" -d "adnroid" --msg "some message"
|
||||
```
|
||||
@ -366,7 +398,8 @@ jobs:
|
||||
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email
|
||||
service: pushbullet
|
||||
```
|
||||
|
||||
@ -381,13 +414,18 @@ jobs:
|
||||
| PUSHBULLET_SMS | "false" |
|
||||
| PUSHBULLET_TITLE | "" |
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
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
|
||||
@ -414,9 +452,11 @@ jobs:
|
||||
TWILLIO_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
|
||||
with:
|
||||
# Chose the messaging platform.
|
||||
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost / twillio
|
||||
# slack / telegram / rocketchat / teams /
|
||||
# pushover / discord / email / mattermost / twillio
|
||||
service: twillio
|
||||
```
|
||||
|
||||
- **Variables**
|
||||
|
||||
| Variables | Default Value |
|
||||
@ -429,16 +469,24 @@ jobs:
|
||||
| TWILLIO_MESSAGE | "" |
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
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. 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
|
||||
pingme email --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"
|
||||
|
||||
pingme email \
|
||||
--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 | Default Value |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user