github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Created Notify_reddit (markdown)

master
Chris Caron 2021-03-04 12:01:22 -05:00
parent abd4711dd9
commit f8f35b0dc8
1 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
Notify_reddit.md Normal file

@ -0,0 +1,55 @@
## Reddit
* **Source**: https://reddit.com
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 6000 Characters per message
### Account Setup
1. Visit https://www.reddit.com/prefs/apps and scroll to the bottom
1. Click on the button that reads '**are you a developer? create an app...**'
1. Set the mode to `script`,
1. Provide a `name`, `description`, and `redirect uri` (it can be anything).
1. Save your configuration:
![Reddit-Setup01](https://user-images.githubusercontent.com/850374/109997361-20372180-7cde-11eb-868d-e5e46bb41873.png)
1. Once the bot is saved, you'll be given a ID (next to the the bot name) and a Secret.
![Reddit-Setup02](https://user-images.githubusercontent.com/850374/109997391-262d0280-7cde-11eb-8681-067c0e00d4ab.png)
- The **App ID** will look something like this: `YWARPXajkk645m`
- The **App Secret** will look something like this: `YZGKc5YNjq3BsC-bf7oBKalBMeb1xA`
- The App will also have a location where you can identify the users/developers who can also use this key. By default it's already configured to be yours. You will need to use the user/pass of one of the accounts identified here as well to use the posting capabilities.
### Syntax
Valid syntax is as follows:
- `reddit://{user}:{pass}@{app_id}/{app_secret}/{subreddit}`
- `reddit://{user}:{pass}@{app_id}/{app_secret}/{subreddit_1}/{subreddit_2}/{subreddit_N}`
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| app_id | Yes | The App ID generated for your **script** application you created on the [Reddit Apps](https://www.reddit.com/prefs/apps) page.
| app_secret | Yes | The App Secret generated for your **script** application you created on the [Reddit Apps](https://www.reddit.com/prefs/apps) page.
| user | Yes | The Reddit UserID associated with one of the developers attached to your application you generated. By default this is just the same user account you used to create the Reddit app in the first place.
| pass Yes | The Reddit password associated with the UserID defined above.
| kind | No | The message kind can be set to either **self**, **link**, or **auto**. By default the value of **auto** is set. The is what tells Reddit if you're posting a general message (`self`) or if you're providing a hyperlink/URI to a website (`link`). The `auto` attempts to determine if the provided message body is a hyperlink/URI and sets the kind automatically based on what was detected.
| ad | No | Specify whether or not what you are posting is an advertisement. By default this is set to **No**.
| nsfw | No | The *Not Safe For Work* (NSFW) flag. By default this is set to **No**.
| replies | No | Send all replies of the thread to your (Reddit) inbox? By default this is set to **Yes**.
| resubmit | No | Let Reddit know this is a re-post. Some subreddits block the re-posting of content; setting this flag to `yes` can enforce that the content be accepted even if this is the case. Some subreddits will even flag the message differently when you identify it as a re-post up front. This may or may not be what you want. By default this is set to **No** so that all messages are treated by the upstream server.
| spoiler | No | Mark your post with the **spoiler** flag. By default this is set to **No**.
| flair_id | No | Provide the `flair_id` you want to associate with your post. By default this is not passed upstream unless identified.
| flair_text | No | Provide the `flair_text` you want to associate with your post. By default this is not passed upstream unless identified.
**Note:** Reddit always requires a `title` to go with it's `body`. Reddit will deny your post (upstream) if you don't provide both.
#### Example
Send a Reddit Notification
```bash
# Assuming our {user} is sstark
# Assuming our {pass} is notAFanOfLannisters
# Assuming our {app_id} is YWARPXajkk645m
# Assuming our {app_secret} is YZGKc5YNjq3BsC-bf7oBKalBMeb1xA
# Assuming we want to post to the {subreddit} Apprise
apprise -vv -t "Test Message Title" -b "Test Message Body" \
reddit://sstark:notAFanOfLannisters@YWARPXajkk645m/YZGKc5YNjq3BsC-bf7oBKalBMeb1xA/Apprise
```