Skip to content

Commit bc13be0

Browse files
authored
Update README.md
Added some brief documentation
1 parent a919d9d commit bc13be0

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# plex2slack-lambda [![CircleCI](https://circleci.com/gh/danesparza/plex2slack-lambda.svg?style=shield)](https://circleci.com/gh/danesparza/plex2slack-lambda)
22
AWS Lambda handler for sending plex webhook messages to a slack channel
3+
4+
## Quick start
5+
### AWS Lambda setup
6+
- Download the latest release and setup a new Go based lambda function in AWS. The handler name is `plex2slack-lambda`
7+
- Add the environment variable `PLEX2SLACK_WEBHOOK_URL` to your lambda handler. Set this to your Slack incoming webhook url. It should look something like *https://hooks.slack.com/services/SOMETHING/SOMEID/SOMETHINGELSEHERE*
8+
9+
### AWS API Gateway setup
10+
- Create a new AWS API Gateway API.
11+
- In the 'Settings' section for the AWS API Gateway for the new API, make sure to add `multipart/form-data` under *Binary Media Types*
12+
- Create a resource (call it something like 'plex') and create a `POST` method on the resource. Wire up the lambda handler on the method. Make sure to select *Use Lambda Proxy integration*
13+
- Deploy the API

0 commit comments

Comments
 (0)