Self-Hosted
/
pingme
mirror of https://github.com/kha7iq/pingme
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #43 from nuugen/docs-fixes

Browse Source 
docs: Fix minor spelling and grammatical mistakes
pull/48/head
Khaliq 4 years ago committed by GitHub
parent 28d78e458f a663aad3ee
commit b85a045a45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File

24
docs/services.md
Unescape View File

@ -1,17 +1,17 @@
# Configuration # Configuration
All the flags have crosponding enviornment variables assosiated with it. You All the flags have corresponding environment variables assosiated with it. You
can either provide the value with flags or export to a variable. You can view can either provide the value with flags or export to a variable. You can view
the crosponding variable to each with --help flag. the corresponding variable to each with --help flag.
*Flags* take presedance over *variables* *Flags* take precedence 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 ','.
```bash ```bash
pingme telegram --token "0125:AAFHvnYf_ABC" --msg "This is a new message ✈" --channel="-1001001001,-1002002001" pingme telegram --token "0125:AAFHvnYf_ABC" --msg "This is a new message ✈" --channel="-1001001001,-1002002001"
@ -57,7 +57,7 @@ jobs:
## RocketChat ## RocketChat
RocketChat uses token & userID to authenticate and send messages to defined RocketChat uses token & userID to authenticate and send messages to defined
channels. Multiple channel ids can be used separated by comma ','. channels. Multiple channel IDs can be used separated by comma ','.
```bash ```bash
pingme rocketchat \ pingme rocketchat \
@ -161,10 +161,10 @@ jobs:
## Mattermost ## Mattermost
Mattermost uses token to authenticate and channel ids for targets. Destination 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 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 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. is used for interacting with server, this can also be changed 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
@ -221,7 +221,7 @@ jobs:
## 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 \ pingme slack \
@ -269,7 +269,7 @@ jobs:
## 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 ','.
```bash ```bash
pingme discord --token '123' --channel '1234567890' --msg 'some message' pingme discord --token '123' --channel '1234567890' --msg 'some message'
@ -566,7 +566,7 @@ jobs:
## Line ## Line
Line uses chanel secret and token for authentication, and sends messages. Line uses channel secret and token for authentication, and sends messages.
```bash ```bash
pingme line pingme line
@ -616,9 +616,9 @@ jobs:
Email uses username & password to authenticate for sending emails. SMTP 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 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 the server. Multiple email IDs can be used separated by comma ',' as receiver
email address. All configuration options are also available via environment email address. All configuration options are also available via environment
variables check configuration section. variables. Check configuration section.
```bash ```bash
pingme email \ pingme email \

Write Preview
Loading…
Cancel
Save