Skip to content

Commit 93f5f0d

Browse files
authored
Merge pull request #18 from Startouf/patch-1
Add readme tips to handle other AWS Regions
2 parents dbfa03f + 515c6dc commit 93f5f0d

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,26 @@ Supported notification formats:
3131
Additional formats will be added; Pull Requests are welcome!
3232

3333
## Try!
34-
Ready to try it for yourself? Installation into your own AWS environment is as
35-
simple as pressing the button below:
34+
Ready to try it for yourself?
35+
36+
**If you are in the us-east-1 AWS Region:**
37+
38+
Installation into your own AWS environment is as
39+
simple as pressing the button below
3640

3741
[![Launch CloudFormation Stack](https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=aws-to-slack&templateURL=https://s3.amazonaws.com/aws-to-slack/cloudformation.yaml)
3842

43+
**If you are not in the us-east-1 AWS Region**
44+
45+
Please refer to the installation instructions below
3946

4047
## Installation
4148

4249
### Step 1 - Setup Slack
43-
The Lambda function communicates with Slack through a
44-
[webhook](https://stashimi.slack.com/apps/A0F7XDUAZ-incoming-webhooks):
50+
The Lambda function communicates with Slack through a Slack webhook
51+
[webhook](https://your-slack-domain.slack.com/apps/manage). Note that you can either create an app, or a custom integration > Incoming webhook (easier, will only let you add a webhook)
4552

46-
1. Navigate to https://slack.com/apps/A0F7XDUAZ-incoming-webhooks and click
53+
1. Navigate to https://your-slack-domain.slack.com/apps/manage and click
4754
"Add Configuration".
4855
2. Choose the default channel where messages will be sent and click
4956
"Add Incoming WebHooks Integration".
@@ -54,12 +61,26 @@ The Lambda function communicates with Slack through a
5461
![Slack Configuration](./docs/config-slack.png)
5562

5663
### Step 2 - Configure & Launch the CloudFormation Stack
64+
65+
Note that the AWS region will be the region from which you launch the CloudFormation wizard, which will also scope the resources (SNS, etc.) to that region.
66+
67+
**If you are launching the CloudFormation Wizard for us-east-1 resources:**
68+
5769
Launch the CloudFormation Stack by using our preconfigured CloudFormation
5870
[template](https://s3.amazonaws.com/aws-to-slack/cloudformation.yaml) or
5971
by simply pressing the following button:
6072

6173
[![Launch CloudFormation Stack](https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png)](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=aws-to-slack&templateURL=https://s3.amazonaws.com/aws-to-slack/cloudformation.yaml)
6274

75+
**If you are not in the us-east-1 AWS Region:**
76+
77+
- Download the release.zip file and upload it so some AWS S3 Bucket (it only works with s3 URLs, plus the format must be `s3://your-bucket/path-to-file`.
78+
- Give public access to this file in S3
79+
- Make a copy of the cloudformation.yaml file, edit the s3 URL so that it points to your newly uploaded file s3 URL
80+
- Go to the CloudFormation interface from you region (you can click one of the links above, but make sure to change the region to yours) then click on "upload from file" and send your modified `cloudformation.yaml` file
81+
82+
**Afterwards**
83+
6384
Click "Next" and on the following page name your new stack and paste the
6485
webhook URL from before into the "HookUrl" field. You can also configure a
6586
different channel to post to if wanted.

0 commit comments

Comments
 (0)