Skip to content

Commit

Permalink
READMEを現状に合わせた
Browse files Browse the repository at this point in the history
  • Loading branch information
mackee committed Dec 20, 2024
1 parent c3539c6 commit a57be30
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,30 @@ notico is Slack event notification bot.

## Usage

1. Create a bot account.
1. Create a Slack Apps account.
2. Invite the account to a channel.
3. Run `notico` with `SLACK_TOKEN` (owned by bot account) and channel (default `#admins`).

3. Get the token and signing secret from the Slack Apps.
4. Set secret SLACK_TOKEN and SLACK_SINGNING_SECRET(default `/notico/prod`) on AWS Secret Manager.
5. Set environment variables.
e.g.
```
export DOMAIN="..."
export NOTICE_CHANNEL_ID="CXXXXXXXX"
export LAMBROLL_TFSTATE="s3://..."
export TF_BACKEND_BUCKET="..."
export TF_BACKEND_KEY="..."
export TF_BACKEND_REGION="..."
```
$ export SLACK_TOKEN=xxxxxx
$ notico [-channel "#foo"]
6. Setup [aqua](jttps://aquaproj.github.io/) and `aqua i`
7. Setup infrastructures by terraform.
```sh
$ task terraform:init
$ task terraform:plan
$ task terraform:apply
```
8. Deploy the lambda function.
```sh
$ task lambda:deploy
```

## Supported Events
Expand All @@ -20,23 +37,11 @@ $ notico [-channel "#foo"]
- channel_rename
- channel_archive
- channel_unarchive
- channel_left
- team_join
- bot_added
- subteam_created

## Options

```
Usage of notico
-channel string
Channel to post notification message (default "#admins")
-version
Show versrion
```

## LICENSE

The MIT License (MIT)

Copyright (c) 2016 KAYAC Inc.
Copyright (c) 2016-2024 KAYAC Inc.

0 comments on commit a57be30

Please sign in to comment.